{ "swagger": "2.0", "info": { "title": "Management API", "version": "0.1", "contact": { "url": "https://github.com/caos/zitadel/pkg/management" } }, "schemes": [ "https" ], "consumes": [ "application/json", "application/grpc" ], "produces": [ "application/json", "application/grpc" ], "paths": { "/global/orgs/_bydomain": { "get": { "summary": "search a organisation by its domain overall organisations", "operationId": "GetOrgByDomainGlobal", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OrgView" } } }, "parameters": [ { "name": "domain", "in": "query", "required": false, "type": "string" } ], "tags": [ "ManagementService" ] } }, "/global/users/_byemail": { "get": { "summary": "GetUserByEmailGlobal returns User, global search is overall organisations", "operationId": "GetUserByEmailGlobal", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1UserView" } } }, "parameters": [ { "name": "email", "in": "query", "required": false, "type": "string" } ], "tags": [ "ManagementService" ] } }, "/grantedprojects/_search": { "post": { "summary": "returns all projects my organisation got granted from another organisation", "operationId": "SearchGrantedProjects", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ProjectGrantSearchResponse" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1GrantedProjectSearchRequest" } } ], "tags": [ "ManagementService" ] } }, "/grantedprojects/{project_id}/grants/{id}": { "get": { "summary": "returns a project my organisation got granted from another organisation", "operationId": "GetGrantedProjectByID", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ProjectGrantView" } } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "type": "string" }, { "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" ] } }, "/iam": { "get": { "summary": "GetIam returns some needed settings of the iam (Global Organisation ID, Zitadel Project ID)", "operationId": "GetIam", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Iam" } } }, "tags": [ "ManagementService" ] } }, "/orgs/me": { "get": { "operationId": "GetMyOrg", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OrgView" } } }, "tags": [ "ManagementService" ] } }, "/orgs/me/_deactivate": { "put": { "operationId": "DeactivateMyOrg", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Org" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "properties": {} } } ], "tags": [ "ManagementService" ] } }, "/orgs/me/_reactivate": { "put": { "operationId": "ReactivateMyOrg", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Org" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "properties": {} } } ], "tags": [ "ManagementService" ] } }, "/orgs/me/domains": { "post": { "operationId": "AddMyOrgDomain", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OrgDomain" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1AddOrgDomainRequest" } } ], "tags": [ "ManagementService" ] } }, "/orgs/me/domains/_search": { "post": { "operationId": "SearchMyOrgDomains", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OrgDomainSearchResponse" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1OrgDomainSearchRequest" } } ], "tags": [ "ManagementService" ] } }, "/orgs/me/domains/{domain}": { "delete": { "operationId": "RemoveMyOrgDomain", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "type": "string" } ], "tags": [ "ManagementService" ] } }, "/orgs/me/iampolicy": { "get": { "operationId": "GetMyOrgIamPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OrgIamPolicy" } } }, "tags": [ "ManagementService" ] } }, "/orgs/me/members": { "post": { "operationId": "AddMyOrgMember", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OrgMember" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1AddOrgMemberRequest" } } ], "tags": [ "ManagementService" ] } }, "/orgs/me/members/_search": { "post": { "operationId": "SearchMyOrgMembers", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OrgMemberSearchResponse" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1OrgMemberSearchRequest" } } ], "tags": [ "ManagementService" ] } }, "/orgs/me/members/{user_id}": { "delete": { "operationId": "RemoveMyOrgMember", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "type": "string" } ], "tags": [ "ManagementService" ] }, "put": { "operationId": "ChangeMyOrgMember", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OrgMember" } } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1ChangeOrgMemberRequest" } } ], "tags": [ "ManagementService" ] } }, "/orgs/members/roles": { "get": { "operationId": "GetOrgMemberRoles", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OrgMemberRoles" } } }, "tags": [ "ManagementService" ] } }, "/orgs/{id}/changes": { "get": { "summary": "OrgChanges returns the event stream of the org object", "operationId": "OrgChanges", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Changes" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "sec_id", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "sequence_offset", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "asc", "in": "query", "required": false, "type": "boolean", "format": "boolean" } ], "tags": [ "ManagementService" ] } }, "/policies/passwords/age": { "get": { "summary": "returns default if nothing other set on organisation", "operationId": "GetPasswordAgePolicy", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1PasswordAgePolicy" } } }, "tags": [ "ManagementService" ] }, "delete": { "operationId": "DeletePasswordAgePolicy", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "id", "in": "query", "required": false, "type": "string" } ], "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" ] }, "put": { "operationId": "UpdatePasswordAgePolicy", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1PasswordAgePolicy" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1PasswordAgePolicyUpdate" } } ], "tags": [ "ManagementService" ] } }, "/policies/passwords/complexity": { "get": { "summary": "returns default policy if nothing other set on organisation", "operationId": "GetPasswordComplexityPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1PasswordComplexityPolicy" } } }, "tags": [ "ManagementService" ] }, "delete": { "operationId": "DeletePasswordComplexityPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "id", "in": "query", "required": false, "type": "string" } ], "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" ] }, "put": { "operationId": "UpdatePasswordComplexityPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1PasswordComplexityPolicy" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1PasswordComplexityPolicyUpdate" } } ], "tags": [ "ManagementService" ] } }, "/policies/passwords/lockout": { "get": { "summary": "returns default if nothing other set on organisation", "operationId": "GetPasswordLockoutPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1PasswordLockoutPolicy" } } }, "tags": [ "ManagementService" ] }, "delete": { "operationId": "DeletePasswordLockoutPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "id", "in": "query", "required": false, "type": "string" } ], "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" ] }, "put": { "operationId": "UpdatePasswordLockoutPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1PasswordLockoutPolicy" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1PasswordLockoutPolicyUpdate" } } ], "tags": [ "ManagementService" ] } }, "/projectgrants/{project_grant_id}/users/grants/_search": { "post": { "summary": "search user grants based on a projectgrant\nThis request is required that the user authorizations of zitadel can be differentiated", "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": { "summary": "create user grant based on a projectgrant\nThis request is required that the user authorizations of zitadel can be differentiated", "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": { "summary": "get user grant based on a projectgrant\nThis request is required that the user authorizations of zitadel can be differentiated", "operationId": "ProjectGrantUserGrantByID", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1UserGrantView" } } }, "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": { "summary": "update user grant based on a projectgrant\nThis request is required that the user authorizations of zitadel can be differentiated", "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": { "summary": "deactivate user grant based on a projectgrant\nThis request is required that the user authorizations of zitadel can be differentiated", "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": { "summary": "reactivate user grant based on a projectgrant\nThis request is required that the user authorizations of zitadel can be differentiated", "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": { "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": { "operationId": "GetProjectGrantMemberRoles", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ProjectGrantMemberRoles" } } }, "tags": [ "ManagementService" ] } }, "/projects/members/roles": { "get": { "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/v1ProjectView" } } }, "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}/applications/{sec_id}/changes": { "get": { "summary": "ApplicationChanges returns the event stream of the application object", "operationId": "ApplicationChanges", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Changes" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "sec_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" }, { "name": "asc", "in": "query", "required": false, "type": "boolean", "format": "boolean" } ], "tags": [ "ManagementService" ] } }, "/projects/{id}/changes": { "get": { "summary": "ProjectChanges returns the event stream of the project object", "operationId": "ProjectChanges", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Changes" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "sec_id", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "sequence_offset", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "asc", "in": "query", "required": false, "type": "boolean", "format": "boolean" } ], "tags": [ "ManagementService" ] } }, "/projects/{id}/members": { "post": { "operationId": "AddProjectMember", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ProjectMember" } } }, "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": { "$ref": "#/definitions/v1ProjectMember" } } }, "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": { "$ref": "#/definitions/v1ProjectRole" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1ProjectRoleAdd" } } ], "tags": [ "ManagementService" ] } }, "/projects/{id}/roles/_bulk": { "post": { "summary": "add a list of project roles in one request", "operationId": "BulkAddProjectRole", "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/v1ProjectRoleAddBulk" } } ], "tags": [ "ManagementService" ] } }, "/projects/{id}/roles/{key}": { "delete": { "summary": "RemoveProjectRole removes role from UserGrants, ProjectGrants and from Project", "operationId": "RemoveProjectRole", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "key", "in": "path", "required": true, "type": "string" } ], "tags": [ "ManagementService" ] }, "put": { "operationId": "ChangeProjectRole", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1ProjectRole" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1ProjectRoleChange" } } ], "tags": [ "ManagementService" ] } }, "/projects/{project_id}/applications/_search": { "post": { "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/v1ApplicationView" } } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" } ], "tags": [ "ManagementService" ] }, "delete": { "operationId": "RemoveApplication", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "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": { "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": { "$ref": "#/definitions/v1ProjectGrantMember" } } }, "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": { "$ref": "#/definitions/v1ProjectGrantMember" } } }, "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/v1ProjectGrantView" } } }, "parameters": [ { "name": "project_id", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" } ], "tags": [ "ManagementService" ] }, "delete": { "summary": "RemoveProjectGrant removes project grant and all user grants for this project grant", "operationId": "RemoveProjectGrant", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "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": { "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": "search user grants based on a project\nThis request is required that the user authorizations of zitadel can be differentiated", "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": { "summary": "create user grant based on a project\nThis request is required that the user authorizations of zitadel can be differentiated", "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": { "summary": "get user grant based on a project\nThis request is required that the user authorizations of zitadel can be differentiated", "operationId": "ProjectUserGrantByID", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1UserGrantView" } } }, "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": { "summary": "update user grant based on a project\nThis request is required that the user authorizations of zitadel can be differentiated", "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": { "summary": "deactivate user grant based on a project\nThis request is required that the user authorizations of zitadel can be differentiated", "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": { "summary": "reactivate user grant based on a project\nThis request is required that the user authorizations of zitadel can be differentiated", "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" ] } }, "/usergrants/_bulk": { "post": { "summary": "add a list of user grants in one request", "operationId": "BulkCreateUserGrant", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1UserGrantCreateBulk" } } ], "tags": [ "ManagementService" ] }, "put": { "summary": "update a list of user grants in one request", "operationId": "BulkUpdateUserGrant", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1UserGrantUpdateBulk" } } ], "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": { "summary": "Limit should always be set, there is a default limit set by the service", "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": { "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": { "operationId": "GetUserByID", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1UserView" } } }, "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}/_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": { "operationId": "GetUserAddress", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1UserAddressView" } } }, "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": { "summary": "UserChanges returns the event stream of the user object", "operationId": "UserChanges", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Changes" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "sec_id", "in": "query", "required": false, "type": "string" }, { "name": "limit", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "sequence_offset", "in": "query", "required": false, "type": "string", "format": "uint64" }, { "name": "asc", "in": "query", "required": false, "type": "boolean", "format": "boolean" } ], "tags": [ "ManagementService" ] } }, "/users/{id}/email": { "get": { "operationId": "GetUserEmail", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1UserEmailView" } } }, "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": { "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}/password/_initialize": { "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}/password/_sendsetnotification": { "post": { "summary": "Sends 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}/phone": { "get": { "operationId": "GetUserPhone", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1UserPhoneView" } } }, "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": { "operationId": "GetUserProfile", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1UserProfileView" } } }, "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/v1UserGrantView" } } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" } ], "tags": [ "ManagementService" ] }, "delete": { "operationId": "RemoveUserGrant", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "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" ] } }, "/usersgrants/_bulk": { "delete": { "summary": "remove a list of user grants in one request", "operationId": "BulkRemoveUserGrant", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1UserGrantRemoveBulk" } } ], "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." }, "v1AddOrgDomainRequest": { "type": "object", "properties": { "domain": { "type": "string" } } }, "v1AddOrgMemberRequest": { "type": "object", "properties": { "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" }, "sequence": { "type": "string", "format": "uint64" } } }, "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/v1ApplicationView" } } } }, "v1ApplicationUpdate": { "type": "object", "properties": { "project_id": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "v1ApplicationView": { "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" }, "sequence": { "type": "string", "format": "uint64" } } }, "v1Change": { "type": "object", "properties": { "change_date": { "type": "string", "format": "date-time" }, "event_type": { "type": "string" }, "sequence": { "type": "string", "format": "uint64" }, "editor_id": { "type": "string" }, "editor": { "type": "string" }, "data": { "$ref": "#/definitions/protobufStruct" } } }, "v1ChangeOrgMemberRequest": { "type": "object", "properties": { "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" }, "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" }, "v1GrantedProjectSearchRequest": { "type": "object", "properties": { "offset": { "type": "string", "format": "uint64" }, "limit": { "type": "string", "format": "uint64" }, "queries": { "type": "array", "items": { "$ref": "#/definitions/v1ProjectSearchQuery" } } } }, "v1Iam": { "type": "object", "properties": { "global_org_id": { "type": "string" }, "iam_project_id": { "type": "string" }, "set_up_done": { "type": "boolean", "format": "boolean" }, "set_up_started": { "type": "boolean", "format": "boolean" } } }, "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" ], "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" }, "sequence": { "type": "string", "format": "uint64" } } }, "v1OrgDomain": { "type": "object", "properties": { "org_id": { "type": "string" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" }, "domain": { "type": "string" }, "verified": { "type": "boolean", "format": "boolean" }, "primary": { "type": "boolean", "format": "boolean" }, "sequence": { "type": "string", "format": "uint64" } } }, "v1OrgDomainSearchKey": { "type": "string", "enum": [ "ORGDOMAINSEARCHKEY_UNSPECIFIED", "ORGDOMAINSEARCHKEY_DOMAIN" ], "default": "ORGDOMAINSEARCHKEY_UNSPECIFIED" }, "v1OrgDomainSearchQuery": { "type": "object", "properties": { "key": { "$ref": "#/definitions/v1OrgDomainSearchKey" }, "method": { "$ref": "#/definitions/v1SearchMethod" }, "value": { "type": "string" } } }, "v1OrgDomainSearchRequest": { "type": "object", "properties": { "offset": { "type": "string", "format": "uint64" }, "limit": { "type": "string", "format": "uint64" }, "queries": { "type": "array", "items": { "$ref": "#/definitions/v1OrgDomainSearchQuery" } } } }, "v1OrgDomainSearchResponse": { "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/v1OrgDomainView" } } } }, "v1OrgDomainView": { "type": "object", "properties": { "org_id": { "type": "string" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" }, "domain": { "type": "string" }, "verified": { "type": "boolean", "format": "boolean" }, "primary": { "type": "boolean", "format": "boolean" }, "sequence": { "type": "string", "format": "uint64" } } }, "v1OrgIamPolicy": { "type": "object", "properties": { "org_id": { "type": "string" }, "description": { "type": "string" }, "user_login_must_be_domain": { "type": "boolean", "format": "boolean" }, "default": { "type": "boolean", "format": "boolean" } } }, "v1OrgMember": { "type": "object", "properties": { "user_id": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "change_date": { "type": "string", "format": "date-time" }, "creation_date": { "type": "string", "format": "date-time" }, "sequence": { "type": "string", "format": "uint64" } } }, "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": { "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/v1OrgMemberView" } } } }, "v1OrgMemberView": { "type": "object", "properties": { "user_id": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "change_date": { "type": "string", "format": "date-time" }, "creation_date": { "type": "string", "format": "date-time" }, "sequence": { "type": "string", "format": "uint64" }, "user_name": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" } } }, "v1OrgState": { "type": "string", "enum": [ "ORGSTATE_UNSPECIFIED", "ORGSTATE_ACTIVE", "ORGSTATE_INACTIVE" ], "default": "ORGSTATE_UNSPECIFIED" }, "v1OrgView": { "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" }, "sequence": { "type": "string", "format": "uint64" } } }, "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" }, "sequence": { "type": "string", "format": "uint64" }, "is_default": { "type": "boolean", "format": "boolean" } } }, "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" }, "sequence": { "type": "string", "format": "uint64" }, "is_default": { "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" }, "sequence": { "type": "string", "format": "uint64" }, "is_default": { "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" }, "sequence": { "type": "string", "format": "uint64" } } }, "v1ProjectCreateRequest": { "type": "object", "properties": { "name": { "type": "string" } } }, "v1ProjectGrant": { "type": "object", "properties": { "id": { "type": "string" }, "project_id": { "type": "string" }, "granted_org_id": { "type": "string" }, "role_keys": { "type": "array", "items": { "type": "string" } }, "state": { "$ref": "#/definitions/v1ProjectGrantState" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" }, "sequence": { "type": "string", "format": "uint64" } } }, "v1ProjectGrantCreate": { "type": "object", "properties": { "project_id": { "type": "string" }, "granted_org_id": { "type": "string" }, "role_keys": { "type": "array", "items": { "type": "string" } } } }, "v1ProjectGrantID": { "type": "object", "properties": { "project_id": { "type": "string" }, "id": { "type": "string" } } }, "v1ProjectGrantMember": { "type": "object", "properties": { "user_id": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "change_date": { "type": "string", "format": "date-time" }, "creation_date": { "type": "string", "format": "date-time" }, "sequence": { "type": "string", "format": "uint64" } } }, "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", "PROJECTGRANTMEMBERSEARCHKEY_USER_NAME" ], "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/v1ProjectGrantMemberView" } } } }, "v1ProjectGrantMemberView": { "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" }, "sequence": { "type": "string", "format": "uint64" } } }, "v1ProjectGrantSearchKey": { "type": "string", "enum": [ "PROJECTGRANTSEARCHKEY_UNSPECIFIED", "PROJECTGRANTSEARCHKEY_PROJECT_NAME", "PROJECTGRANTSEARCHKEY_ROLE_KEY" ], "default": "PROJECTGRANTSEARCHKEY_UNSPECIFIED" }, "v1ProjectGrantSearchQuery": { "type": "object", "properties": { "key": { "$ref": "#/definitions/v1ProjectGrantSearchKey" }, "method": { "$ref": "#/definitions/v1SearchMethod" }, "value": { "type": "string" } } }, "v1ProjectGrantSearchRequest": { "type": "object", "properties": { "project_id": { "type": "string" }, "offset": { "type": "string", "format": "uint64" }, "limit": { "type": "string", "format": "uint64" }, "queries": { "type": "array", "items": { "$ref": "#/definitions/v1ProjectGrantSearchQuery" } } } }, "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/v1ProjectGrantView" } } } }, "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_keys": { "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_keys": { "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_keys": { "type": "array", "items": { "type": "string" } } } }, "v1ProjectGrantView": { "type": "object", "properties": { "id": { "type": "string" }, "project_id": { "type": "string" }, "granted_org_id": { "type": "string" }, "granted_org_name": { "type": "string" }, "role_keys": { "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" }, "sequence": { "type": "string", "format": "uint64" }, "resource_owner": { "type": "string" }, "resource_owner_name": { "type": "string" } } }, "v1ProjectID": { "type": "object", "properties": { "id": { "type": "string" } } }, "v1ProjectMember": { "type": "object", "properties": { "user_id": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "change_date": { "type": "string", "format": "date-time" }, "creation_date": { "type": "string", "format": "date-time" }, "sequence": { "type": "string", "format": "uint64" } } }, "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", "PROJECTMEMBERSEARCHKEY_USER_NAME" ], "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/v1ProjectMemberView" } } } }, "v1ProjectMemberView": { "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" }, "sequence": { "type": "string", "format": "uint64" } } }, "v1ProjectRole": { "type": "object", "properties": { "project_id": { "type": "string" }, "key": { "type": "string" }, "display_name": { "type": "string" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" }, "group": { "type": "string" }, "sequence": { "type": "string", "format": "uint64" } } }, "v1ProjectRoleAdd": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "display_name": { "type": "string" }, "group": { "type": "string" } } }, "v1ProjectRoleAddBulk": { "type": "object", "properties": { "id": { "type": "string" }, "project_roles": { "type": "array", "items": { "$ref": "#/definitions/v1ProjectRoleAdd" } } } }, "v1ProjectRoleChange": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "display_name": { "type": "string" }, "group": { "type": "string" } } }, "v1ProjectRoleSearchKey": { "type": "string", "enum": [ "PROJECTROLESEARCHKEY_UNSPECIFIED", "PROJECTROLESEARCHKEY_KEY", "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/v1ProjectRoleView" } } } }, "v1ProjectRoleView": { "type": "object", "properties": { "project_id": { "type": "string" }, "key": { "type": "string" }, "display_name": { "type": "string" }, "creation_date": { "type": "string", "format": "date-time" }, "group": { "type": "string" }, "sequence": { "type": "string", "format": "uint64" } } }, "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/v1ProjectView" } } } }, "v1ProjectState": { "type": "string", "enum": [ "PROJECTSTATE_UNSPECIFIED", "PROJECTSTATE_ACTIVE", "PROJECTSTATE_INACTIVE" ], "default": "PROJECTSTATE_UNSPECIFIED" }, "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_keys": { "type": "array", "items": { "type": "string" } } } }, "v1ProjectView": { "type": "object", "properties": { "project_id": { "type": "string" }, "name": { "type": "string" }, "state": { "$ref": "#/definitions/v1ProjectState" }, "change_date": { "type": "string", "format": "date-time" }, "creation_date": { "type": "string", "format": "date-time" }, "resource_owner": { "type": "string" }, "sequence": { "type": "string", "format": "uint64" } } }, "v1SearchMethod": { "type": "string", "enum": [ "SEARCHMETHOD_EQUALS", "SEARCHMETHOD_STARTS_WITH", "SEARCHMETHOD_CONTAINS", "SEARCHMETHOD_EQUALS_IGNORE_CASE", "SEARCHMETHOD_STARTS_WITH_IGNORE_CASE", "SEARCHMETHOD_CONTAINS_IGNORE_CASE", "SEARCHMETHOD_NOT_EQUALS", "SEARCHMETHOD_GREATER_THAN", "SEARCHMETHOD_LESS_THAN", "SEARCHMETHOD_IS_ONE_OF", "SEARCHMETHOD_LIST_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" }, "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" }, "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" }, "sequence": { "type": "string", "format": "uint64" } } }, "v1UserAddress": { "type": "object", "properties": { "id": { "type": "string" }, "country": { "type": "string" }, "locality": { "type": "string" }, "postal_code": { "type": "string" }, "region": { "type": "string" }, "street_address": { "type": "string" }, "sequence": { "type": "string", "format": "uint64" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" } } }, "v1UserAddressView": { "type": "object", "properties": { "id": { "type": "string" }, "country": { "type": "string" }, "locality": { "type": "string" }, "postal_code": { "type": "string" }, "region": { "type": "string" }, "street_address": { "type": "string" }, "sequence": { "type": "string", "format": "uint64" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" } } }, "v1UserEmail": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_email_verified": { "type": "boolean", "format": "boolean" }, "sequence": { "type": "string", "format": "uint64" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" } } }, "v1UserEmailView": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "is_email_verified": { "type": "boolean", "format": "boolean" }, "sequence": { "type": "string", "format": "uint64" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" } } }, "v1UserGrant": { "type": "object", "properties": { "id": { "type": "string" }, "user_id": { "type": "string" }, "org_id": { "type": "string" }, "project_id": { "type": "string" }, "role_keys": { "type": "array", "items": { "type": "string" } }, "state": { "$ref": "#/definitions/v1UserGrantState" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" }, "sequence": { "type": "string", "format": "uint64" } } }, "v1UserGrantCreate": { "type": "object", "properties": { "user_id": { "type": "string" }, "project_id": { "type": "string" }, "role_keys": { "type": "array", "items": { "type": "string" } } } }, "v1UserGrantCreateBulk": { "type": "object", "properties": { "user_grants": { "type": "array", "items": { "$ref": "#/definitions/v1UserGrantCreate" } } } }, "v1UserGrantID": { "type": "object", "properties": { "user_id": { "type": "string" }, "id": { "type": "string" } } }, "v1UserGrantRemoveBulk": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } } }, "v1UserGrantSearchKey": { "type": "string", "enum": [ "USERGRANTSEARCHKEY_UNSPECIFIED", "USERGRANTSEARCHKEY_PROJECT_ID", "USERGRANTSEARCHKEY_USER_ID", "USERGRANTSEARCHKEY_ORG_ID", "USERGRANTSEARCHKEY_ROLE_KEY" ], "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/v1UserGrantView" } } } }, "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_keys": { "type": "array", "items": { "type": "string" } } } }, "v1UserGrantUpdateBulk": { "type": "object", "properties": { "user_grants": { "type": "array", "items": { "$ref": "#/definitions/v1UserGrantUpdate" } } } }, "v1UserGrantView": { "type": "object", "properties": { "id": { "type": "string" }, "user_id": { "type": "string" }, "org_id": { "type": "string" }, "project_id": { "type": "string" }, "role_keys": { "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" }, "sequence": { "type": "string", "format": "uint64" }, "resource_owner": { "type": "string" }, "display_name": { "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" }, "sequence": { "type": "string", "format": "uint64" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" } } }, "v1UserPhoneView": { "type": "object", "properties": { "id": { "type": "string" }, "phone": { "type": "string" }, "is_phone_verified": { "type": "boolean", "format": "boolean" }, "sequence": { "type": "string", "format": "uint64" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" } } }, "v1UserProfile": { "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" }, "user_name": { "type": "string" }, "sequence": { "type": "string", "format": "uint64" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" } } }, "v1UserProfileView": { "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" }, "user_name": { "type": "string" }, "sequence": { "type": "string", "format": "uint64" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" }, "login_names": { "type": "array", "items": { "type": "string" } }, "preferred_login_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/v1UserView" } } } }, "v1UserState": { "type": "string", "enum": [ "USERSTATE_UNSPECIFIED", "USERSTATE_ACTIVE", "USERSTATE_INACTIVE", "USERSTATE_DELETED", "USERSTATE_LOCKED", "USERSTATE_SUSPEND", "USERSTATE_INITIAL" ], "default": "USERSTATE_UNSPECIFIED" }, "v1UserView": { "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" }, "sequence": { "type": "string", "format": "uint64" }, "resource_owner": { "type": "string" }, "login_names": { "type": "array", "items": { "type": "string" } }, "preferred_login_name": { "type": "string" } } } } }