zitadel/pkg/management/api/grpc/management.swagger.json
2020-03-23 10:52:06 +01:00

5658 lines
128 KiB
JSON

{
"swagger": "2.0",
"info": {
"title": "Management API",
"version": "0.1",
"contact": {
"url": "https://github.com/caos/citadel/management"
}
},
"schemes": [
"https"
],
"consumes": [
"application/json",
"application/grpc"
],
"produces": [
"application/json",
"application/grpc"
],
"paths": {
"/applications/{id}/changes": {
"get": {
"operationId": "ApplicationChanges",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Changes"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "string",
"format": "uint64"
},
{
"name": "sequence_offset",
"in": "query",
"required": false,
"type": "string",
"format": "uint64"
}
],
"tags": [
"ManagementService"
]
}
},
"/authgrants/_search": {
"post": {
"summary": "Grant",
"operationId": "SearchAuthGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1AuthGrantSearchResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1AuthGrantSearchRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/global/orgs/domain/{domain}": {
"get": {
"operationId": "GetOrgByDomainGlobal",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Org"
}
}
},
"parameters": [
{
"name": "domain",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
}
},
"/global/users/email/{email}": {
"get": {
"operationId": "GetUserByEmailGlobal",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1User"
}
}
},
"parameters": [
{
"name": "email",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
}
},
"/grants/{id}": {
"get": {
"summary": "GRANTED_PROJECT_GRANTS",
"operationId": "GetGrantedProjectGrantByID",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ProjectGrant"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
}
},
"/healthz": {
"get": {
"summary": "READINESS",
"operationId": "Healthz",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"tags": [
"ManagementService"
]
}
},
"/orgs/members/roles": {
"get": {
"summary": "ORG_MEMBERS",
"operationId": "GetOrgMemberRoles",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1OrgMemberRoles"
}
}
},
"tags": [
"ManagementService"
]
}
},
"/orgs/{id}": {
"get": {
"summary": "ORG",
"operationId": "GetOrgByID",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Org"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
}
},
"/orgs/{id}/_deactivate": {
"put": {
"operationId": "DeactivateOrg",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Org"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1OrgID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/orgs/{id}/_reactivate": {
"put": {
"operationId": "ReactivateOrg",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Org"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1OrgID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/orgs/{id}/changes": {
"get": {
"operationId": "OrgChanges",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Changes"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "string",
"format": "uint64"
},
{
"name": "sequence_offset",
"in": "query",
"required": false,
"type": "string",
"format": "uint64"
}
],
"tags": [
"ManagementService"
]
}
},
"/orgs/{org_id}/members": {
"post": {
"operationId": "AddOrgMember",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "org_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1AddOrgMemberRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/orgs/{org_id}/members/_search": {
"post": {
"operationId": "SearchOrgMembers",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1OrgMemberSearchResponse"
}
}
},
"parameters": [
{
"name": "org_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1OrgMemberSearchRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/orgs/{org_id}/members/{user_id}": {
"delete": {
"operationId": "RemoveOrgMember",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "org_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "ChangeOrgMember",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "org_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ChangeOrgMemberRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/policies/passwords/age": {
"get": {
"summary": "PASSWORD_AGE_POLICY",
"operationId": "GetPasswordAgePolicy",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1PasswordAgePolicy"
}
}
},
"tags": [
"ManagementService"
]
},
"post": {
"operationId": "CreatePasswordAgePolicy",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1PasswordAgePolicy"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1PasswordAgePolicyCreate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/policies/passwords/age/{id}": {
"delete": {
"operationId": "DeletePasswordAgePolicy",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "UpdatePasswordAgePolicy",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1PasswordAgePolicy"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1PasswordAgePolicyUpdate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/policies/passwords/complexity": {
"get": {
"summary": "PASSWORD_COMPLEXITY_POLICY",
"operationId": "GetPasswordComplexityPolicy",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1PasswordComplexityPolicy"
}
}
},
"tags": [
"ManagementService"
]
},
"post": {
"operationId": "CreatePasswordComplexityPolicy",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1PasswordComplexityPolicy"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1PasswordComplexityPolicyCreate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/policies/passwords/complexity/{id}": {
"delete": {
"operationId": "DeletePasswordComplexityPolicy",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "UpdatePasswordComplexityPolicy",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1PasswordComplexityPolicy"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1PasswordComplexityPolicyUpdate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/policies/passwords/lockout": {
"get": {
"summary": "PASSWORD_LOCKOUT_POLICY",
"operationId": "GetPasswordLockoutPolicy",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1PasswordLockoutPolicy"
}
}
},
"tags": [
"ManagementService"
]
},
"post": {
"operationId": "CreatePasswordLockoutPolicy",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1PasswordLockoutPolicy"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1PasswordLockoutPolicyCreate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/policies/passwords/lockout/{id}": {
"delete": {
"operationId": "DeletePasswordLockoutPolicy",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "UpdatePasswordLockoutPolicy",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1PasswordLockoutPolicy"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1PasswordLockoutPolicyUpdate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projectgrants/{project_grant_id}/users/grants/_search": {
"post": {
"summary": "PROJECT_GRANT_USER_GRANT",
"operationId": "SearchProjectGrantUserGrants",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrantSearchResponse"
}
}
},
"parameters": [
{
"name": "project_grant_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectGrantUserGrantSearchRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projectgrants/{project_grant_id}/users/{user_id}/grants": {
"post": {
"operationId": "CreateProjectGrantUserGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "project_grant_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectGrantUserGrantCreate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projectgrants/{project_grant_id}/users/{user_id}/grants/{id}": {
"get": {
"operationId": "ProjectGrantUserGrantByID",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "project_grant_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "UpdateProjectGrantUserGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "project_grant_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectGrantUserGrantUpdate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projectgrants/{project_grant_id}/users/{user_id}/grants/{id}/_deactivate": {
"put": {
"operationId": "DeactivateProjectGrantUserGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "project_grant_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectGrantUserGrantID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projectgrants/{project_grant_id}/users/{user_id}/grants/{id}/_reactivate": {
"put": {
"operationId": "ReactivateProjectGrantUserGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "project_grant_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectGrantUserGrantID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects": {
"post": {
"operationId": "CreateProject",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Project"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectCreateRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/_search": {
"post": {
"summary": "PROJECTS",
"operationId": "SearchProjects",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ProjectSearchResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectSearchRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/grants/members/roles": {
"get": {
"summary": "PROJECT_GRANT_MEMBER",
"operationId": "GetProjectGrantMemberRoles",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ProjectGrantMemberRoles"
}
}
},
"tags": [
"ManagementService"
]
}
},
"/projects/members/roles": {
"get": {
"summary": "PROJECT_MEMBERS",
"operationId": "GetProjectMemberRoles",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ProjectMemberRoles"
}
}
},
"tags": [
"ManagementService"
]
}
},
"/projects/{id}": {
"get": {
"operationId": "ProjectByID",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Project"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "UpdateProject",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Project"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectUpdateRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{id}/_deactivate": {
"put": {
"operationId": "DeactivateProject",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Project"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{id}/_reactivate": {
"put": {
"operationId": "ReactivateProject",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Project"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{id}/changes": {
"get": {
"operationId": "ProjectChanges",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Changes"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "string",
"format": "uint64"
},
{
"name": "sequence_offset",
"in": "query",
"required": false,
"type": "string",
"format": "uint64"
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{id}/members": {
"post": {
"operationId": "AddProjectMember",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectMemberAdd"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{id}/members/{user_id}": {
"delete": {
"operationId": "RemoveProjectMember",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "ChangeProjectMember",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectMemberChange"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{id}/roles": {
"post": {
"operationId": "AddProjectRole",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectRoleAdd"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{id}/roles/{name}": {
"delete": {
"operationId": "RemoveProjectRole",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/applications/_search": {
"post": {
"summary": "APPLICATIONS",
"operationId": "SearchApplications",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ApplicationSearchResponse"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ApplicationSearchRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/applications/{application_id}/oidcconfig": {
"put": {
"operationId": "UpdateApplicationOIDCConfig",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1OIDCConfig"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "application_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1OIDCConfigUpdate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/applications/{id}": {
"get": {
"operationId": "ApplicationByID",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Application"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "UpdateApplication",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Application"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ApplicationUpdate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/applications/{id}/_deactivate": {
"put": {
"operationId": "DeactivateApplication",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Application"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ApplicationID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/applications/{id}/_reactivate": {
"put": {
"operationId": "ReactivateApplication",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Application"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ApplicationID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/applications/{id}/oidcconfig/_changeclientsecret": {
"put": {
"operationId": "RegenerateOIDCClientSecret",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ClientSecret"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ApplicationID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/grants": {
"post": {
"operationId": "CreateProjectGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ProjectGrant"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectGrantCreate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/grants/_search": {
"post": {
"summary": "PROJECT_GRANT",
"operationId": "SearchProjectGrants",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ProjectGrantSearchResponse"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectGrantSearchRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/grants/{grant_id}/members": {
"post": {
"operationId": "AddProjectGrantMember",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "grant_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectGrantMemberAdd"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/grants/{grant_id}/members/_search": {
"post": {
"operationId": "SearchProjectGrantMembers",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ProjectGrantMemberSearchResponse"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "grant_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectGrantMemberSearchRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/grants/{grant_id}/members/{user_id}": {
"delete": {
"operationId": "RemoveProjectGrantMember",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "grant_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "ChangeProjectGrantMember",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "grant_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectGrantMemberChange"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/grants/{id}": {
"get": {
"operationId": "ProjectGrantByID",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ProjectGrant"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "UpdateProjectGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ProjectGrant"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectGrantUpdate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/grants/{id}/_deactivate": {
"put": {
"operationId": "DeactivateProjectGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ProjectGrant"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectGrantID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/grants/{id}/_reactivate": {
"put": {
"operationId": "ReactivateProjectGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ProjectGrant"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectGrantID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/members/_search": {
"post": {
"operationId": "SearchProjectMembers",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ProjectMemberSearchResponse"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectMemberSearchRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/oidcapplications": {
"post": {
"operationId": "CreateOIDCApplication",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Application"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1OIDCApplicationCreate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/roles/_search": {
"post": {
"summary": "PROJECT_ROLES",
"operationId": "SearchProjectRoles",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1ProjectRoleSearchResponse"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectRoleSearchRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/users/grants/_search": {
"post": {
"summary": "PROJECT_USER_GRANT",
"operationId": "SearchProjectUserGrants",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrantSearchResponse"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectUserGrantSearchRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/users/{user_id}/grants": {
"post": {
"operationId": "CreateProjectUserGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UserGrantCreate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/users/{user_id}/grants/{id}": {
"get": {
"operationId": "ProjectUserGrantByID",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "UpdateProjectUserGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectUserGrantUpdate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/users/{user_id}/grants/{id}/_deactivate": {
"put": {
"operationId": "DeactivateProjectUserGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectUserGrantID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/projects/{project_id}/users/{user_id}/grants/{id}/_reactivate": {
"put": {
"operationId": "ReactivateProjectUserGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "project_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1ProjectUserGrantID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/ready": {
"get": {
"operationId": "Ready",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"tags": [
"ManagementService"
]
}
},
"/users": {
"post": {
"operationId": "CreateUser",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1User"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1CreateUserRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/_isunique": {
"get": {
"operationId": "IsUserUnique",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UniqueUserResponse"
}
}
},
"parameters": [
{
"name": "user_name",
"in": "query",
"required": false,
"type": "string"
},
{
"name": "email",
"in": "query",
"required": false,
"type": "string"
}
],
"tags": [
"ManagementService"
]
}
},
"/users/_search": {
"post": {
"operationId": "SearchUsers",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserSearchResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UserSearchRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/grants/_search": {
"post": {
"summary": "USER_GRANT",
"operationId": "SearchUserGrants",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrantSearchResponse"
}
}
},
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UserGrantSearchRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}": {
"get": {
"summary": "USER",
"operationId": "GetUserByID",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1User"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"delete": {
"operationId": "DeleteUser",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}/_deactivate": {
"put": {
"operationId": "DeactivateUser",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1User"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UserID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}/_lock": {
"put": {
"operationId": "LockUser",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1User"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UserID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}/_reactivate": {
"put": {
"operationId": "ReactivateUser",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1User"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UserID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}/_sendsetpwnotify": {
"post": {
"summary": "PASSWORD\nSends an Notification (Email/SMS) with a password reset Link",
"operationId": "SendSetPasswordNotification",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1SetPasswordNotificationRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}/_setinitialpw": {
"post": {
"summary": "A Manager is only allowed to set an initial password, on the next login the user has to change his password",
"operationId": "SetInitialPassword",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1PasswordRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}/_unlock": {
"put": {
"operationId": "UnlockUser",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1User"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UserID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}/address": {
"get": {
"summary": "USER_ADDRESS",
"operationId": "GetUserAddress",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserAddress"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "UpdateUserAddress",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserAddress"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UpdateUserAddressRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}/changes": {
"get": {
"operationId": "UserChanges",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1Changes"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "limit",
"in": "query",
"required": false,
"type": "string",
"format": "uint64"
},
{
"name": "sequence_offset",
"in": "query",
"required": false,
"type": "string",
"format": "uint64"
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}/email": {
"get": {
"summary": "USER_EMAIL",
"operationId": "GetUserEmail",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserEmail"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "ChangeUserEmail",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserEmail"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UpdateUserEmailRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}/email/_resendverification": {
"post": {
"operationId": "ResendEmailVerificationMail",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UserID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}/mfas": {
"get": {
"summary": "MFA",
"operationId": "GetUserMfas",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1MultiFactors"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}/phone": {
"get": {
"summary": "USER_PHONE",
"operationId": "GetUserPhone",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserPhone"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "ChangeUserPhone",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserPhone"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UpdateUserPhoneRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}/phone/_resendverification": {
"post": {
"operationId": "ResendPhoneVerificationCode",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"properties": {}
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UserID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{id}/profile": {
"get": {
"summary": "USER_PROFILE",
"operationId": "GetUserProfile",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserProfile"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "UpdateUserProfile",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserProfile"
}
}
},
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UpdateUserProfileRequest"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{user_id}/grants": {
"post": {
"operationId": "CreateUserGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UserGrantCreate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{user_id}/grants/{id}": {
"get": {
"operationId": "UserGrantByID",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
}
],
"tags": [
"ManagementService"
]
},
"put": {
"operationId": "UpdateUserGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UserGrantUpdate"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{user_id}/grants/{id}/_deactivate": {
"put": {
"operationId": "DeactivateUserGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UserGrantID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/users/{user_id}/grants/{id}/_reactivate": {
"put": {
"operationId": "ReactivateUserGrant",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UserGrant"
}
}
},
"parameters": [
{
"name": "user_id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/v1UserGrantID"
}
}
],
"tags": [
"ManagementService"
]
}
},
"/validate": {
"get": {
"operationId": "Validate",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/protobufStruct"
}
}
},
"tags": [
"ManagementService"
]
}
}
},
"definitions": {
"protobufListValue": {
"type": "object",
"properties": {
"values": {
"type": "array",
"items": {
"$ref": "#/definitions/protobufValue"
},
"description": "Repeated field of dynamically typed values."
}
},
"description": "`ListValue` is a wrapper around a repeated field of values.\n\nThe JSON representation for `ListValue` is JSON array."
},
"protobufNullValue": {
"type": "string",
"enum": [
"NULL_VALUE"
],
"default": "NULL_VALUE",
"description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\n The JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value."
},
"protobufStruct": {
"type": "object",
"properties": {
"fields": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/protobufValue"
},
"description": "Unordered map of dynamically typed values."
}
},
"description": "`Struct` represents a structured data value, consisting of fields\nwhich map to dynamically typed values. In some languages, `Struct`\nmight be supported by a native representation. For example, in\nscripting languages like JS a struct is represented as an\nobject. The details of that representation are described together\nwith the proto support for the language.\n\nThe JSON representation for `Struct` is JSON object."
},
"protobufValue": {
"type": "object",
"properties": {
"null_value": {
"$ref": "#/definitions/protobufNullValue",
"description": "Represents a null value."
},
"number_value": {
"type": "number",
"format": "double",
"description": "Represents a double value."
},
"string_value": {
"type": "string",
"description": "Represents a string value."
},
"bool_value": {
"type": "boolean",
"format": "boolean",
"description": "Represents a boolean value."
},
"struct_value": {
"$ref": "#/definitions/protobufStruct",
"description": "Represents a structured value."
},
"list_value": {
"$ref": "#/definitions/protobufListValue",
"description": "Represents a repeated `Value`."
}
},
"description": "`Value` represents a dynamically typed value which can be either\nnull, a number, a string, a boolean, a recursive struct value, or a\nlist of values. A producer of value is expected to set one of that\nvariants, absence of any variant indicates an error.\n\nThe JSON representation for `Value` is JSON value."
},
"v1AddOrgMemberRequest": {
"type": "object",
"properties": {
"org_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1AppState": {
"type": "string",
"enum": [
"APPSTATE_UNSPECIFIED",
"APPSTATE_ACTIVE",
"APPSTATE_INACTIVE"
],
"default": "APPSTATE_UNSPECIFIED"
},
"v1Application": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"state": {
"$ref": "#/definitions/v1AppState"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"change_date": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"oidc_config": {
"$ref": "#/definitions/v1OIDCConfig"
}
}
},
"v1ApplicationID": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"project_id": {
"type": "string"
}
}
},
"v1ApplicationSearchKey": {
"type": "string",
"enum": [
"APPLICATIONSERACHKEY_UNSPECIFIED",
"APPLICATIONSEARCHKEY_APP_NAME"
],
"default": "APPLICATIONSERACHKEY_UNSPECIFIED"
},
"v1ApplicationSearchQuery": {
"type": "object",
"properties": {
"key": {
"$ref": "#/definitions/v1ApplicationSearchKey"
},
"method": {
"$ref": "#/definitions/v1SearchMethod"
},
"value": {
"type": "string"
}
}
},
"v1ApplicationSearchRequest": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"queries": {
"type": "array",
"items": {
"$ref": "#/definitions/v1ApplicationSearchQuery"
}
}
}
},
"v1ApplicationSearchResponse": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"total_result": {
"type": "string",
"format": "uint64"
},
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/v1Application"
}
}
}
},
"v1ApplicationUpdate": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"v1AuthGrant": {
"type": "object",
"properties": {
"orgId": {
"type": "string"
},
"projectId": {
"type": "string"
},
"userId": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1AuthGrantSearchKey": {
"type": "string",
"enum": [
"AUTHGRANTSEARCHKEY_UNSPECIFIED",
"AUTHGRANTSEARCHKEY_ORG_ID",
"AUTHGRANTSEARCHKEY_PROJECT_ID",
"AUTHGRANTSEARCHKEY_USER_ID"
],
"default": "AUTHGRANTSEARCHKEY_UNSPECIFIED"
},
"v1AuthGrantSearchQuery": {
"type": "object",
"properties": {
"key": {
"$ref": "#/definitions/v1AuthGrantSearchKey"
},
"method": {
"$ref": "#/definitions/v1SearchMethod"
},
"value": {
"type": "string"
}
}
},
"v1AuthGrantSearchRequest": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"sorting_column": {
"$ref": "#/definitions/v1AuthGrantSearchKey"
},
"asc": {
"type": "boolean",
"format": "boolean"
},
"queries": {
"type": "array",
"items": {
"$ref": "#/definitions/v1AuthGrantSearchQuery"
}
}
}
},
"v1AuthGrantSearchResponse": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"total_result": {
"type": "string",
"format": "uint64"
},
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/v1AuthGrant"
}
}
}
},
"v1Change": {
"type": "object",
"properties": {
"change_date": {
"type": "string",
"format": "date-time"
},
"event_type": {
"type": "string"
},
"sequence": {
"type": "string",
"format": "uint64"
},
"modifier": {
"type": "string"
},
"data": {
"$ref": "#/definitions/protobufStruct"
}
}
},
"v1ChangeOrgMemberRequest": {
"type": "object",
"properties": {
"org_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1Changes": {
"type": "object",
"properties": {
"changes": {
"type": "array",
"items": {
"$ref": "#/definitions/v1Change"
}
},
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
}
}
},
"v1ClientSecret": {
"type": "object",
"properties": {
"client_secret": {
"type": "string"
}
}
},
"v1CreateUserRequest": {
"type": "object",
"properties": {
"user_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"nick_name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"preferred_language": {
"type": "string"
},
"gender": {
"$ref": "#/definitions/v1Gender"
},
"email": {
"type": "string"
},
"is_email_verified": {
"type": "boolean",
"format": "boolean"
},
"phone": {
"type": "string"
},
"is_phone_verified": {
"type": "boolean",
"format": "boolean"
},
"country": {
"type": "string"
},
"locality": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"region": {
"type": "string"
},
"street_address": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"v1Gender": {
"type": "string",
"enum": [
"GENDER_UNSPECIFIED",
"GENDER_FEMALE",
"GENDER_MALE",
"GENDER_DIVERSE"
],
"default": "GENDER_UNSPECIFIED"
},
"v1MFAState": {
"type": "string",
"enum": [
"MFASTATE_UNSPECIFIED",
"MFASTATE_NOT_READY",
"MFASTATE_READY",
"MFASTATE_REMOVED"
],
"default": "MFASTATE_UNSPECIFIED"
},
"v1MfaType": {
"type": "string",
"enum": [
"MFATYPE_UNSPECIFIED",
"MFATYPE_SMS",
"MFATYPE_OTP"
],
"default": "MFATYPE_UNSPECIFIED"
},
"v1MultiFactor": {
"type": "object",
"properties": {
"type": {
"$ref": "#/definitions/v1MfaType"
},
"state": {
"$ref": "#/definitions/v1MFAState"
}
}
},
"v1MultiFactors": {
"type": "object",
"properties": {
"mfas": {
"type": "array",
"items": {
"$ref": "#/definitions/v1MultiFactor"
}
}
}
},
"v1NotificationType": {
"type": "string",
"enum": [
"NOTIFICATIONTYPE_EMAIL",
"NOTIFICATIONTYPE_SMS"
],
"default": "NOTIFICATIONTYPE_EMAIL"
},
"v1OIDCApplicationCreate": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"name": {
"type": "string"
},
"redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
},
"response_types": {
"type": "array",
"items": {
"$ref": "#/definitions/v1OIDCResponseType"
}
},
"grant_types": {
"type": "array",
"items": {
"$ref": "#/definitions/v1OIDCGrantType"
}
},
"application_type": {
"$ref": "#/definitions/v1OIDCApplicationType"
},
"auth_method_type": {
"$ref": "#/definitions/v1OIDCAuthMethodType"
},
"post_logout_redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1OIDCApplicationType": {
"type": "string",
"enum": [
"OIDCAPPLICATIONTYPE_WEB",
"OIDCAPPLICATIONTYPE_USER_AGENT",
"OIDCAPPLICATIONTYPE_NATIVE"
],
"default": "OIDCAPPLICATIONTYPE_WEB"
},
"v1OIDCAuthMethodType": {
"type": "string",
"enum": [
"OIDCAUTHMETHODTYPE_BASIC",
"OIDCAUTHMETHODTYPE_POST",
"OIDCAUTHMETHODTYPE_NONE"
],
"default": "OIDCAUTHMETHODTYPE_BASIC"
},
"v1OIDCConfig": {
"type": "object",
"properties": {
"redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
},
"response_types": {
"type": "array",
"items": {
"$ref": "#/definitions/v1OIDCResponseType"
}
},
"grant_types": {
"type": "array",
"items": {
"$ref": "#/definitions/v1OIDCGrantType"
}
},
"application_type": {
"$ref": "#/definitions/v1OIDCApplicationType"
},
"client_id": {
"type": "string"
},
"client_secret": {
"type": "string"
},
"auth_method_type": {
"$ref": "#/definitions/v1OIDCAuthMethodType"
},
"post_logout_redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1OIDCConfigUpdate": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"application_id": {
"type": "string"
},
"redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
},
"response_types": {
"type": "array",
"items": {
"$ref": "#/definitions/v1OIDCResponseType"
}
},
"grant_types": {
"type": "array",
"items": {
"$ref": "#/definitions/v1OIDCGrantType"
}
},
"application_type": {
"$ref": "#/definitions/v1OIDCApplicationType"
},
"auth_method_type": {
"$ref": "#/definitions/v1OIDCAuthMethodType"
},
"post_logout_redirect_uris": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1OIDCGrantType": {
"type": "string",
"enum": [
"OIDCGRANTTYPE_AUTHORIZATION_CODE",
"OIDCGRANTTYPE_IMPLICIT",
"OIDCGRANTTYPE_REFRESH_TOKEN"
],
"default": "OIDCGRANTTYPE_AUTHORIZATION_CODE"
},
"v1OIDCResponseType": {
"type": "string",
"enum": [
"OIDCRESPONSETYPE_CODE",
"OIDCRESPONSETYPE_ID_TOKEN",
"OIDCRESPONSETYPE_TOKEN_ID_TOKEN"
],
"default": "OIDCRESPONSETYPE_CODE"
},
"v1Org": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"state": {
"$ref": "#/definitions/v1OrgState"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"change_date": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string"
},
"domain": {
"type": "string"
}
}
},
"v1OrgID": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
},
"v1OrgMember": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"user_name": {
"type": "string"
},
"email": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"change_date": {
"type": "string",
"format": "date-time"
},
"creation_date": {
"type": "string",
"format": "date-time"
}
}
},
"v1OrgMemberRoles": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1OrgMemberSearchKey": {
"type": "string",
"enum": [
"ORGMEMBERSEARCHKEY_UNSPECIFIED",
"ORGMEMBERSEARCHKEY_FIRST_NAME",
"ORGMEMBERSEARCHKEY_LAST_NAME",
"ORGMEMBERSEARCHKEY_EMAIL",
"ORGMEMBERSEARCHKEY_USER_ID"
],
"default": "ORGMEMBERSEARCHKEY_UNSPECIFIED"
},
"v1OrgMemberSearchQuery": {
"type": "object",
"properties": {
"key": {
"$ref": "#/definitions/v1OrgMemberSearchKey"
},
"method": {
"$ref": "#/definitions/v1SearchMethod"
},
"value": {
"type": "string"
}
}
},
"v1OrgMemberSearchRequest": {
"type": "object",
"properties": {
"org_id": {
"type": "string"
},
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"queries": {
"type": "array",
"items": {
"$ref": "#/definitions/v1OrgMemberSearchQuery"
}
}
}
},
"v1OrgMemberSearchResponse": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"total_result": {
"type": "string",
"format": "uint64"
},
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/v1OrgMember"
}
}
}
},
"v1OrgState": {
"type": "string",
"enum": [
"ORGSTATE_UNSPECIFIED",
"ORGSTATE_ACTIVE",
"ORGSTATE_INACTIVE"
],
"default": "ORGSTATE_UNSPECIFIED"
},
"v1PasswordAgePolicy": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"$ref": "#/definitions/v1PolicyState"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"change_date": {
"type": "string",
"format": "date-time"
},
"max_age_days": {
"type": "string",
"format": "uint64"
},
"expire_warn_days": {
"type": "string",
"format": "uint64"
}
}
},
"v1PasswordAgePolicyCreate": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"max_age_days": {
"type": "string",
"format": "uint64"
},
"expire_warn_days": {
"type": "string",
"format": "uint64"
}
}
},
"v1PasswordAgePolicyUpdate": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"description": {
"type": "string"
},
"max_age_days": {
"type": "string",
"format": "uint64"
},
"expire_warn_days": {
"type": "string",
"format": "uint64"
}
}
},
"v1PasswordComplexityPolicy": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"$ref": "#/definitions/v1PolicyState"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"change_date": {
"type": "string",
"format": "date-time"
},
"min_length": {
"type": "string",
"format": "uint64"
},
"has_lowercase": {
"type": "boolean",
"format": "boolean"
},
"has_uppercase": {
"type": "boolean",
"format": "boolean"
},
"has_number": {
"type": "boolean",
"format": "boolean"
},
"has_symbol": {
"type": "boolean",
"format": "boolean"
}
}
},
"v1PasswordComplexityPolicyCreate": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"min_length": {
"type": "string",
"format": "uint64"
},
"has_lowercase": {
"type": "boolean",
"format": "boolean"
},
"has_uppercase": {
"type": "boolean",
"format": "boolean"
},
"has_number": {
"type": "boolean",
"format": "boolean"
},
"has_symbol": {
"type": "boolean",
"format": "boolean"
}
}
},
"v1PasswordComplexityPolicyUpdate": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"description": {
"type": "string"
},
"min_length": {
"type": "string",
"format": "uint64"
},
"has_lowercase": {
"type": "boolean",
"format": "boolean"
},
"has_uppercase": {
"type": "boolean",
"format": "boolean"
},
"has_number": {
"type": "boolean",
"format": "boolean"
},
"has_symbol": {
"type": "boolean",
"format": "boolean"
}
}
},
"v1PasswordLockoutPolicy": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"description": {
"type": "string"
},
"state": {
"$ref": "#/definitions/v1PolicyState"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"change_date": {
"type": "string",
"format": "date-time"
},
"max_attempts": {
"type": "string",
"format": "uint64"
},
"show_lock_out_failures": {
"type": "boolean",
"format": "boolean"
}
}
},
"v1PasswordLockoutPolicyCreate": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"max_attempts": {
"type": "string",
"format": "uint64"
},
"show_lock_out_failures": {
"type": "boolean",
"format": "boolean"
}
}
},
"v1PasswordLockoutPolicyUpdate": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"description": {
"type": "string"
},
"max_attempts": {
"type": "string",
"format": "uint64"
},
"show_lock_out_failures": {
"type": "boolean",
"format": "boolean"
}
}
},
"v1PasswordRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"password": {
"type": "string"
}
}
},
"v1PolicyState": {
"type": "string",
"enum": [
"POLICYSTATE_UNSPECIFIED",
"POLICYSTATE_ACTIVE",
"POLICYSTATE_INACTIVE",
"POLICYSTATE_DELETED"
],
"default": "POLICYSTATE_UNSPECIFIED"
},
"v1Project": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"$ref": "#/definitions/v1ProjectState"
},
"change_date": {
"type": "string",
"format": "date-time"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"type": {
"$ref": "#/definitions/v1ProjectType"
},
"resource_owner": {
"type": "string"
},
"org_id": {
"type": "string"
},
"org_name": {
"type": "string"
},
"org_domain": {
"type": "string"
},
"grant_id": {
"type": "string"
}
}
},
"v1ProjectCreateRequest": {
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
},
"v1ProjectGrant": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"project_id": {
"type": "string"
},
"granted_org_id": {
"type": "string"
},
"granted_org_name": {
"type": "string"
},
"granted_org_domain": {
"type": "string"
},
"role_names": {
"type": "array",
"items": {
"type": "string"
}
},
"state": {
"$ref": "#/definitions/v1ProjectGrantState"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"change_date": {
"type": "string",
"format": "date-time"
},
"project_name": {
"type": "string"
}
}
},
"v1ProjectGrantCreate": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"granted_org_id": {
"type": "string"
},
"role_names": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1ProjectGrantID": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"v1ProjectGrantMember": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"user_name": {
"type": "string"
},
"email": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"change_date": {
"type": "string",
"format": "date-time"
},
"creation_date": {
"type": "string",
"format": "date-time"
}
}
},
"v1ProjectGrantMemberAdd": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"grant_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1ProjectGrantMemberChange": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"grant_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1ProjectGrantMemberRoles": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1ProjectGrantMemberSearchKey": {
"type": "string",
"enum": [
"PROJECTGRANTMEMBERSEARCHKEY_UNSPECIFIED",
"PROJECTGRANTMEMBERSEARCHKEY_FIRST_NAME",
"PROJECTGRANTMEMBERSEARCHKEY_LAST_NAME",
"PROJECTGRANTMEMBERSEARCHKEY_EMAIL",
"PROJECTGRANTMEMBERSEARCHKEY_USER_ID"
],
"default": "PROJECTGRANTMEMBERSEARCHKEY_UNSPECIFIED"
},
"v1ProjectGrantMemberSearchQuery": {
"type": "object",
"properties": {
"key": {
"$ref": "#/definitions/v1ProjectGrantMemberSearchKey"
},
"method": {
"$ref": "#/definitions/v1SearchMethod"
},
"value": {
"type": "string"
}
}
},
"v1ProjectGrantMemberSearchRequest": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"grant_id": {
"type": "string"
},
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"queries": {
"type": "array",
"items": {
"$ref": "#/definitions/v1ProjectGrantMemberSearchQuery"
}
}
}
},
"v1ProjectGrantMemberSearchResponse": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"total_result": {
"type": "string",
"format": "uint64"
},
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/v1ProjectGrantMember"
}
}
}
},
"v1ProjectGrantSearchRequest": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
}
}
},
"v1ProjectGrantSearchResponse": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"total_result": {
"type": "string",
"format": "uint64"
},
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/v1ProjectGrant"
}
}
}
},
"v1ProjectGrantState": {
"type": "string",
"enum": [
"PROJECTGRANTSTATE_UNSPECIFIED",
"PROJECTGRANTSTATE_ACTIVE",
"PROJECTGRANTSTATE_INACTIVE"
],
"default": "PROJECTGRANTSTATE_UNSPECIFIED"
},
"v1ProjectGrantUpdate": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"id": {
"type": "string"
},
"role_names": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1ProjectGrantUserGrantCreate": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"org_id": {
"type": "string"
},
"project_grant_id": {
"type": "string"
},
"project_id": {
"type": "string"
},
"role_names": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1ProjectGrantUserGrantID": {
"type": "object",
"properties": {
"project_grant_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"v1ProjectGrantUserGrantSearchRequest": {
"type": "object",
"properties": {
"project_grant_id": {
"type": "string"
},
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"queries": {
"type": "array",
"items": {
"$ref": "#/definitions/v1UserGrantSearchQuery"
}
}
}
},
"v1ProjectGrantUserGrantUpdate": {
"type": "object",
"properties": {
"project_grant_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"id": {
"type": "string"
},
"role_names": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1ProjectID": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
},
"v1ProjectMember": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"user_name": {
"type": "string"
},
"email": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
},
"change_date": {
"type": "string",
"format": "date-time"
},
"creation_date": {
"type": "string",
"format": "date-time"
}
}
},
"v1ProjectMemberAdd": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1ProjectMemberChange": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1ProjectMemberRoles": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1ProjectMemberSearchKey": {
"type": "string",
"enum": [
"PROJECTMEMBERSEARCHKEY_UNSPECIFIED",
"PROJECTMEMBERSEARCHKEY_FIRST_NAME",
"PROJECTMEMBERSEARCHKEY_LAST_NAME",
"PROJECTMEMBERSEARCHKEY_EMAIL",
"PROJECTMEMBERSEARCHKEY_USER_ID"
],
"default": "PROJECTMEMBERSEARCHKEY_UNSPECIFIED"
},
"v1ProjectMemberSearchQuery": {
"type": "object",
"properties": {
"key": {
"$ref": "#/definitions/v1ProjectMemberSearchKey"
},
"method": {
"$ref": "#/definitions/v1SearchMethod"
},
"value": {
"type": "string"
}
}
},
"v1ProjectMemberSearchRequest": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"queries": {
"type": "array",
"items": {
"$ref": "#/definitions/v1ProjectMemberSearchQuery"
}
}
}
},
"v1ProjectMemberSearchResponse": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"total_result": {
"type": "string",
"format": "uint64"
},
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/v1ProjectMember"
}
}
}
},
"v1ProjectRole": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"group": {
"type": "string"
}
}
},
"v1ProjectRoleAdd": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"group": {
"type": "string"
}
}
},
"v1ProjectRoleSearchKey": {
"type": "string",
"enum": [
"PROJECTROLESEARCHKEY_UNSPECIFIED",
"PROJECTROLESEARCHKEY_NAME",
"PROJECTROLESEARCHKEY_DISPLAY_NAME"
],
"default": "PROJECTROLESEARCHKEY_UNSPECIFIED"
},
"v1ProjectRoleSearchQuery": {
"type": "object",
"properties": {
"key": {
"$ref": "#/definitions/v1ProjectRoleSearchKey"
},
"method": {
"$ref": "#/definitions/v1SearchMethod"
},
"value": {
"type": "string"
}
}
},
"v1ProjectRoleSearchRequest": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"queries": {
"type": "array",
"items": {
"$ref": "#/definitions/v1ProjectRoleSearchQuery"
}
}
}
},
"v1ProjectRoleSearchResponse": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"total_result": {
"type": "string",
"format": "uint64"
},
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/v1ProjectRole"
}
}
}
},
"v1ProjectSearchKey": {
"type": "string",
"enum": [
"PROJECTSEARCHKEY_UNSPECIFIED",
"PROJECTSEARCHKEY_PROJECT_NAME"
],
"default": "PROJECTSEARCHKEY_UNSPECIFIED"
},
"v1ProjectSearchQuery": {
"type": "object",
"properties": {
"key": {
"$ref": "#/definitions/v1ProjectSearchKey"
},
"method": {
"$ref": "#/definitions/v1SearchMethod"
},
"value": {
"type": "string"
}
}
},
"v1ProjectSearchRequest": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"queries": {
"type": "array",
"items": {
"$ref": "#/definitions/v1ProjectSearchQuery"
}
}
}
},
"v1ProjectSearchResponse": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"total_result": {
"type": "string",
"format": "uint64"
},
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/v1Project"
}
}
}
},
"v1ProjectState": {
"type": "string",
"enum": [
"PROJECTSTATE_UNSPECIFIED",
"PROJECTSTATE_ACTIVE",
"PROJECTSSTATE_INACTIVE"
],
"default": "PROJECTSTATE_UNSPECIFIED"
},
"v1ProjectType": {
"type": "string",
"enum": [
"PROJECTTYPE_UNKNOWN",
"PROJECTTYPE_SELF",
"PROJECTTYPE_GRANTED"
],
"default": "PROJECTTYPE_UNKNOWN"
},
"v1ProjectUpdateRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"v1ProjectUserGrantID": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"v1ProjectUserGrantSearchRequest": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"queries": {
"type": "array",
"items": {
"$ref": "#/definitions/v1UserGrantSearchQuery"
}
}
}
},
"v1ProjectUserGrantUpdate": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"id": {
"type": "string"
},
"role_names": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1SearchMethod": {
"type": "string",
"enum": [
"SEARCHMETHOD_EQUALS",
"SEARCHMETHOD_STARTS_WITH",
"SEARCHMETHOD_CONTAINS"
],
"default": "SEARCHMETHOD_EQUALS"
},
"v1SetPasswordNotificationRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/definitions/v1NotificationType"
}
}
},
"v1UniqueUserResponse": {
"type": "object",
"properties": {
"is_unique": {
"type": "boolean",
"format": "boolean"
}
}
},
"v1UpdateUserAddressRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"country": {
"type": "string"
},
"locality": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"region": {
"type": "string"
},
"street_address": {
"type": "string"
}
}
},
"v1UpdateUserEmailRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"email": {
"type": "string"
},
"is_email_verified": {
"type": "boolean",
"format": "boolean"
}
}
},
"v1UpdateUserPhoneRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"phone": {
"type": "string"
},
"is_phone_verified": {
"type": "boolean",
"format": "boolean"
}
}
},
"v1UpdateUserProfileRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"nick_name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"preferred_language": {
"type": "string"
},
"gender": {
"$ref": "#/definitions/v1Gender"
}
}
},
"v1User": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"state": {
"$ref": "#/definitions/v1UserState"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"change_date": {
"type": "string",
"format": "date-time"
},
"last_login": {
"type": "string",
"format": "date-time"
},
"password_changed": {
"type": "string",
"format": "date-time"
},
"user_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"nick_name": {
"type": "string"
},
"preferred_language": {
"type": "string"
},
"gender": {
"$ref": "#/definitions/v1Gender"
},
"email": {
"type": "string"
},
"is_email_verified": {
"type": "boolean",
"format": "boolean"
},
"phone": {
"type": "string"
},
"is_phone_verified": {
"type": "boolean",
"format": "boolean"
},
"country": {
"type": "string"
},
"locality": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"region": {
"type": "string"
},
"street_address": {
"type": "string"
}
}
},
"v1UserAddress": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"country": {
"type": "string"
},
"locality": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"region": {
"type": "string"
},
"street_address": {
"type": "string"
}
}
},
"v1UserEmail": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"email": {
"type": "string"
},
"is_email_verified": {
"type": "boolean",
"format": "boolean"
}
}
},
"v1UserGrant": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"org_id": {
"type": "string"
},
"project_id": {
"type": "string"
},
"role_names": {
"type": "array",
"items": {
"type": "string"
}
},
"state": {
"$ref": "#/definitions/v1UserGrantState"
},
"creation_date": {
"type": "string",
"format": "date-time"
},
"change_date": {
"type": "string",
"format": "date-time"
},
"user_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"org_name": {
"type": "string"
},
"org_domain": {
"type": "string"
},
"project_name": {
"type": "string"
}
}
},
"v1UserGrantCreate": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"org_id": {
"type": "string"
},
"project_id": {
"type": "string"
},
"role_names": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1UserGrantID": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"id": {
"type": "string"
}
}
},
"v1UserGrantSearchKey": {
"type": "string",
"enum": [
"USERGRANTSEARCHKEY_UNSPECIFIED",
"USERGRANTSEARCHKEY_PROJECT_ID",
"USERGRANTSEARCHKEY_USER_ID",
"USERGRANTSEARCHKEY_ORG_ID"
],
"default": "USERGRANTSEARCHKEY_UNSPECIFIED"
},
"v1UserGrantSearchQuery": {
"type": "object",
"properties": {
"key": {
"$ref": "#/definitions/v1UserGrantSearchKey"
},
"method": {
"$ref": "#/definitions/v1SearchMethod"
},
"value": {
"type": "string"
}
}
},
"v1UserGrantSearchRequest": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"queries": {
"type": "array",
"items": {
"$ref": "#/definitions/v1UserGrantSearchQuery"
}
}
}
},
"v1UserGrantSearchResponse": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"total_result": {
"type": "string",
"format": "uint64"
},
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/v1UserGrant"
}
}
}
},
"v1UserGrantState": {
"type": "string",
"enum": [
"USERGRANTSTATE_UNSPECIFIED",
"USERGRANTSTATE_ACTIVE",
"USERGRANTSTATE_INACTIVE"
],
"default": "USERGRANTSTATE_UNSPECIFIED"
},
"v1UserGrantUpdate": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"id": {
"type": "string"
},
"role_names": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"v1UserID": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
}
},
"v1UserPhone": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"phone": {
"type": "string"
},
"is_phone_verified": {
"type": "boolean",
"format": "boolean"
}
}
},
"v1UserProfile": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"state": {
"$ref": "#/definitions/v1UserState"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"nick_name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"preferred_language": {
"type": "string"
},
"gender": {
"$ref": "#/definitions/v1Gender"
},
"user_name": {
"type": "string"
}
}
},
"v1UserSearchKey": {
"type": "string",
"enum": [
"USERSEARCHKEY_UNSPECIFIED",
"USERSEARCHKEY_USER_NAME",
"USERSEARCHKEY_FIRST_NAME",
"USERSEARCHKEY_LAST_NAME",
"USERSEARCHKEY_NICK_NAME",
"USERSEARCHKEY_DISPLAY_NAME",
"USERSEARCHKEY_EMAIL",
"USERSEARCHKEY_STATE"
],
"default": "USERSEARCHKEY_UNSPECIFIED"
},
"v1UserSearchQuery": {
"type": "object",
"properties": {
"key": {
"$ref": "#/definitions/v1UserSearchKey"
},
"method": {
"$ref": "#/definitions/v1SearchMethod"
},
"value": {
"type": "string"
}
}
},
"v1UserSearchRequest": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"sorting_column": {
"$ref": "#/definitions/v1UserSearchKey"
},
"asc": {
"type": "boolean",
"format": "boolean"
},
"queries": {
"type": "array",
"items": {
"$ref": "#/definitions/v1UserSearchQuery"
}
}
}
},
"v1UserSearchResponse": {
"type": "object",
"properties": {
"offset": {
"type": "string",
"format": "uint64"
},
"limit": {
"type": "string",
"format": "uint64"
},
"total_result": {
"type": "string",
"format": "uint64"
},
"result": {
"type": "array",
"items": {
"$ref": "#/definitions/v1User"
}
}
}
},
"v1UserState": {
"type": "string",
"enum": [
"USERSTATE_UNSPECIFIED",
"USERSTATE_ACTIVE",
"USERSTATE_INACTIVE",
"USERSTATE_DELETED",
"USERSTATE_LOCKED",
"USERSTATE_SUSPEND",
"USERSTATE_INITIAL"
],
"default": "USERSTATE_UNSPECIFIED"
}
}
}