2020-03-23 15:56:02 +00:00
{
"swagger" : "2.0" ,
"info" : {
"title" : "Management API" ,
"version" : "0.1" ,
"contact" : {
2020-03-25 09:54:45 +00:00
"url" : "https://github.com/caos/zitadel/pkg/management"
2020-03-23 15:56:02 +00:00
}
} ,
"schemes" : [
"https"
] ,
"consumes" : [
"application/json" ,
"application/grpc"
] ,
"produces" : [
"application/json" ,
"application/grpc"
] ,
"paths" : {
2020-06-23 08:09:30 +00:00
"/global/orgs/_bydomain" : {
2020-03-23 15:56:02 +00:00
"get" : {
2020-06-23 08:09:30 +00:00
"summary" : "search a organisation by its domain overall organisations" ,
2020-03-23 15:56:02 +00:00
"operationId" : "GetOrgByDomainGlobal" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-06-23 05:06:07 +00:00
"$ref" : "#/definitions/v1OrgView"
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
"name" : "domain" ,
2020-06-16 09:40:18 +00:00
"in" : "query" ,
"required" : false ,
"type" : "string"
2020-03-23 15:56:02 +00:00
}
] ,
"tags" : [
"ManagementService"
]
}
} ,
2020-06-23 08:09:30 +00:00
"/global/users/_byemail" : {
2020-03-23 15:56:02 +00:00
"get" : {
2020-06-23 08:09:30 +00:00
"summary" : "GetUserByEmailGlobal returns User, global search is overall organisations" ,
2020-03-23 15:56:02 +00:00
"operationId" : "GetUserByEmailGlobal" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-05-12 04:30:53 +00:00
"$ref" : "#/definitions/v1UserView"
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
"name" : "email" ,
2020-06-23 08:09:30 +00:00
"in" : "query" ,
"required" : false ,
2020-03-23 15:56:02 +00:00
"type" : "string"
}
] ,
"tags" : [
"ManagementService"
]
}
} ,
2020-05-11 10:16:29 +00:00
"/grantedprojects/_search" : {
"post" : {
2020-06-23 08:09:30 +00:00
"summary" : "returns all projects my organisation got granted from another organisation" ,
2020-05-11 10:16:29 +00:00
"operationId" : "SearchGrantedProjects" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-06-15 12:50:39 +00:00
"$ref" : "#/definitions/v1ProjectGrantSearchResponse"
2020-05-11 10:16:29 +00:00
}
}
} ,
"parameters" : [
{
"name" : "body" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/v1GrantedProjectSearchRequest"
}
}
] ,
"tags" : [
"ManagementService"
]
}
} ,
"/grantedprojects/{project_id}/grants/{id}" : {
2020-03-23 15:56:02 +00:00
"get" : {
2020-06-23 08:09:30 +00:00
"summary" : "returns a project my organisation got granted from another organisation" ,
2020-06-15 12:50:39 +00:00
"operationId" : "GetGrantedProjectByID" ,
2020-03-23 15:56:02 +00:00
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-06-15 12:50:39 +00:00
"$ref" : "#/definitions/v1ProjectGrantView"
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
2020-05-11 10:16:29 +00:00
{
"name" : "project_id" ,
"in" : "path" ,
"required" : true ,
"type" : "string"
} ,
2020-03-23 15:56:02 +00:00
{
"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"
]
}
} ,
2020-06-17 05:25:04 +00:00
"/iam" : {
"get" : {
2020-06-23 08:09:30 +00:00
"summary" : "GetIam returns some needed settings of the iam (Global Organisation ID, Zitadel Project ID)" ,
2020-06-17 05:25:04 +00:00
"operationId" : "GetIam" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
"$ref" : "#/definitions/v1Iam"
}
}
} ,
"tags" : [
"ManagementService"
]
}
} ,
2020-06-23 08:09:30 +00:00
"/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"
]
}
} ,
2020-06-16 09:40:18 +00:00
"/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"
]
}
} ,
2020-06-19 05:27:16 +00:00
"/orgs/me/iampolicy" : {
"get" : {
"operationId" : "GetMyOrgIamPolicy" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
"$ref" : "#/definitions/v1OrgIamPolicy"
}
}
} ,
"tags" : [
"ManagementService"
]
}
} ,
2020-06-10 08:47:50 +00:00
"/orgs/me/members" : {
"post" : {
"operationId" : "AddMyOrgMember" ,
2020-03-23 15:56:02 +00:00
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-06-10 08:47:50 +00:00
"$ref" : "#/definitions/v1OrgMember"
2020-03-23 15:56:02 +00:00
}
}
} ,
2020-06-10 08:47:50 +00:00
"parameters" : [
{
"name" : "body" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/v1AddOrgMemberRequest"
}
}
] ,
2020-03-23 15:56:02 +00:00
"tags" : [
"ManagementService"
]
}
} ,
2020-06-10 08:47:50 +00:00
"/orgs/me/members/_search" : {
"post" : {
"operationId" : "SearchMyOrgMembers" ,
2020-03-23 15:56:02 +00:00
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-06-10 08:47:50 +00:00
"$ref" : "#/definitions/v1OrgMemberSearchResponse"
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
2020-06-10 08:47:50 +00:00
"name" : "body" ,
"in" : "body" ,
2020-03-23 15:56:02 +00:00
"required" : true ,
2020-06-10 08:47:50 +00:00
"schema" : {
"$ref" : "#/definitions/v1OrgMemberSearchRequest"
}
2020-03-23 15:56:02 +00:00
}
] ,
"tags" : [
"ManagementService"
]
}
} ,
2020-06-10 08:47:50 +00:00
"/orgs/me/members/{user_id}" : {
"delete" : {
"operationId" : "RemoveMyOrgMember" ,
2020-03-23 15:56:02 +00:00
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-06-10 08:47:50 +00:00
"properties" : { }
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
2020-06-10 08:47:50 +00:00
"name" : "user_id" ,
2020-03-23 15:56:02 +00:00
"in" : "path" ,
"required" : true ,
"type" : "string"
}
] ,
"tags" : [
"ManagementService"
]
2020-06-10 08:47:50 +00:00
} ,
2020-03-23 15:56:02 +00:00
"put" : {
2020-06-10 08:47:50 +00:00
"operationId" : "ChangeMyOrgMember" ,
2020-03-23 15:56:02 +00:00
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-06-10 08:47:50 +00:00
"$ref" : "#/definitions/v1OrgMember"
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
2020-06-10 08:47:50 +00:00
"name" : "user_id" ,
2020-03-23 15:56:02 +00:00
"in" : "path" ,
"required" : true ,
"type" : "string"
} ,
{
"name" : "body" ,
"in" : "body" ,
"required" : true ,
"schema" : {
2020-06-10 08:47:50 +00:00
"$ref" : "#/definitions/v1ChangeOrgMemberRequest"
2020-03-23 15:56:02 +00:00
}
}
] ,
"tags" : [
"ManagementService"
]
}
} ,
2020-06-10 08:47:50 +00:00
"/orgs/members/roles" : {
2020-03-23 15:56:02 +00:00
"get" : {
2020-06-10 08:47:50 +00:00
"operationId" : "GetOrgMemberRoles" ,
2020-03-23 15:56:02 +00:00
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-06-10 08:47:50 +00:00
"$ref" : "#/definitions/v1OrgMemberRoles"
2020-03-23 15:56:02 +00:00
}
}
} ,
"tags" : [
"ManagementService"
]
}
} ,
2020-06-10 08:47:50 +00:00
"/orgs/{id}/changes" : {
"get" : {
2020-06-23 08:09:30 +00:00
"summary" : "OrgChanges returns the event stream of the org object" ,
2020-06-10 08:47:50 +00:00
"operationId" : "OrgChanges" ,
2020-03-23 15:56:02 +00:00
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-06-10 08:47:50 +00:00
"$ref" : "#/definitions/v1Changes"
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
2020-06-10 08:47:50 +00:00
"name" : "id" ,
2020-03-23 15:56:02 +00:00
"in" : "path" ,
"required" : true ,
"type" : "string"
} ,
2020-06-15 14:50:09 +00:00
{
"name" : "sec_id" ,
"in" : "query" ,
"required" : false ,
"type" : "string"
} ,
2020-03-23 15:56:02 +00:00
{
2020-06-10 08:47:50 +00:00
"name" : "limit" ,
"in" : "query" ,
"required" : false ,
"type" : "string" ,
"format" : "uint64"
2020-03-23 15:56:02 +00:00
} ,
{
2020-06-10 08:47:50 +00:00
"name" : "sequence_offset" ,
"in" : "query" ,
"required" : false ,
"type" : "string" ,
"format" : "uint64"
2020-06-25 09:25:38 +00:00
} ,
{
"name" : "asc" ,
"in" : "query" ,
"required" : false ,
"type" : "boolean" ,
"format" : "boolean"
2020-03-23 15:56:02 +00:00
}
] ,
"tags" : [
"ManagementService"
]
}
} ,
"/policies/passwords/age" : {
"get" : {
2020-06-23 08:09:30 +00:00
"summary" : "returns default if nothing other set on organisation" ,
2020-03-23 15:56:02 +00:00
"operationId" : "GetPasswordAgePolicy" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
"$ref" : "#/definitions/v1PasswordAgePolicy"
}
}
} ,
"tags" : [
"ManagementService"
]
} ,
2020-05-14 09:48:57 +00:00
"delete" : {
"operationId" : "DeletePasswordAgePolicy" ,
2020-03-23 15:56:02 +00:00
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-05-14 09:48:57 +00:00
"properties" : { }
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
2020-05-14 09:48:57 +00:00
"name" : "id" ,
"in" : "query" ,
"required" : false ,
"type" : "string"
2020-03-23 15:56:02 +00:00
}
] ,
"tags" : [
"ManagementService"
]
2020-05-14 09:48:57 +00:00
} ,
"post" : {
"operationId" : "CreatePasswordAgePolicy" ,
2020-03-23 15:56:02 +00:00
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-05-14 09:48:57 +00:00
"$ref" : "#/definitions/v1PasswordAgePolicy"
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
2020-05-14 09:48:57 +00:00
"name" : "body" ,
"in" : "body" ,
2020-03-23 15:56:02 +00:00
"required" : true ,
2020-05-14 09:48:57 +00:00
"schema" : {
"$ref" : "#/definitions/v1PasswordAgePolicyCreate"
}
2020-03-23 15:56:02 +00:00
}
] ,
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "returns default policy if nothing other set on organisation" ,
2020-03-23 15:56:02 +00:00
"operationId" : "GetPasswordComplexityPolicy" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
"$ref" : "#/definitions/v1PasswordComplexityPolicy"
}
}
} ,
"tags" : [
"ManagementService"
]
} ,
2020-05-14 09:48:57 +00:00
"delete" : {
"operationId" : "DeletePasswordComplexityPolicy" ,
2020-03-23 15:56:02 +00:00
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-05-14 09:48:57 +00:00
"properties" : { }
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
2020-05-14 09:48:57 +00:00
"name" : "id" ,
"in" : "query" ,
"required" : false ,
"type" : "string"
2020-03-23 15:56:02 +00:00
}
] ,
"tags" : [
"ManagementService"
]
2020-05-14 09:48:57 +00:00
} ,
"post" : {
"operationId" : "CreatePasswordComplexityPolicy" ,
2020-03-23 15:56:02 +00:00
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-05-14 09:48:57 +00:00
"$ref" : "#/definitions/v1PasswordComplexityPolicy"
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
2020-05-14 09:48:57 +00:00
"name" : "body" ,
"in" : "body" ,
2020-03-23 15:56:02 +00:00
"required" : true ,
2020-05-14 09:48:57 +00:00
"schema" : {
"$ref" : "#/definitions/v1PasswordComplexityPolicyCreate"
}
2020-03-23 15:56:02 +00:00
}
] ,
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "returns default if nothing other set on organisation" ,
2020-03-23 15:56:02 +00:00
"operationId" : "GetPasswordLockoutPolicy" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
"$ref" : "#/definitions/v1PasswordLockoutPolicy"
}
}
} ,
"tags" : [
"ManagementService"
]
} ,
2020-05-14 09:48:57 +00:00
"delete" : {
"operationId" : "DeletePasswordLockoutPolicy" ,
2020-03-23 15:56:02 +00:00
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-05-14 09:48:57 +00:00
"properties" : { }
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
2020-05-14 09:48:57 +00:00
"name" : "id" ,
"in" : "query" ,
"required" : false ,
"type" : "string"
2020-03-23 15:56:02 +00:00
}
] ,
"tags" : [
"ManagementService"
]
2020-05-14 09:48:57 +00:00
} ,
"post" : {
"operationId" : "CreatePasswordLockoutPolicy" ,
2020-03-23 15:56:02 +00:00
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-05-14 09:48:57 +00:00
"$ref" : "#/definitions/v1PasswordLockoutPolicy"
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
2020-05-14 09:48:57 +00:00
"name" : "body" ,
"in" : "body" ,
2020-03-23 15:56:02 +00:00
"required" : true ,
2020-05-14 09:48:57 +00:00
"schema" : {
"$ref" : "#/definitions/v1PasswordLockoutPolicyCreate"
}
2020-03-23 15:56:02 +00:00
}
] ,
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "search user grants based on a projectgrant\nThis request is required that the user authorizations of zitadel can be differentiated" ,
2020-03-23 15:56:02 +00:00
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "create user grant based on a projectgrant\nThis request is required that the user authorizations of zitadel can be differentiated" ,
2020-03-23 15:56:02 +00:00
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "get user grant based on a projectgrant\nThis request is required that the user authorizations of zitadel can be differentiated" ,
2020-03-23 15:56:02 +00:00
"operationId" : "ProjectGrantUserGrantByID" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-06-23 05:06:07 +00:00
"$ref" : "#/definitions/v1UserGrantView"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "update user grant based on a projectgrant\nThis request is required that the user authorizations of zitadel can be differentiated" ,
2020-03-23 15:56:02 +00:00
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "deactivate user grant based on a projectgrant\nThis request is required that the user authorizations of zitadel can be differentiated" ,
2020-03-23 15:56:02 +00:00
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "reactivate user grant based on a projectgrant\nThis request is required that the user authorizations of zitadel can be differentiated" ,
2020-03-23 15:56:02 +00:00
"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"
]
}
} ,
2020-06-15 12:50:39 +00:00
"/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"
]
}
} ,
2020-03-23 15:56:02 +00:00
"/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" : {
2020-06-23 05:06:07 +00:00
"$ref" : "#/definitions/v1ProjectView"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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"
]
}
} ,
2020-06-15 14:50:09 +00:00
"/projects/{id}/applications/{sec_id}/changes" : {
"get" : {
2020-06-23 08:09:30 +00:00
"summary" : "ApplicationChanges returns the event stream of the application object" ,
2020-06-15 14:50:09 +00:00
"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"
2020-06-25 09:25:38 +00:00
} ,
{
"name" : "asc" ,
"in" : "query" ,
"required" : false ,
"type" : "boolean" ,
"format" : "boolean"
2020-06-15 14:50:09 +00:00
}
] ,
"tags" : [
"ManagementService"
]
}
} ,
2020-03-23 15:56:02 +00:00
"/projects/{id}/changes" : {
"get" : {
2020-06-23 08:09:30 +00:00
"summary" : "ProjectChanges returns the event stream of the project object" ,
2020-03-23 15:56:02 +00:00
"operationId" : "ProjectChanges" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
"$ref" : "#/definitions/v1Changes"
}
}
} ,
"parameters" : [
{
"name" : "id" ,
"in" : "path" ,
"required" : true ,
"type" : "string"
} ,
2020-06-15 14:50:09 +00:00
{
"name" : "sec_id" ,
"in" : "query" ,
"required" : false ,
"type" : "string"
} ,
2020-03-23 15:56:02 +00:00
{
"name" : "limit" ,
"in" : "query" ,
"required" : false ,
"type" : "string" ,
"format" : "uint64"
} ,
{
"name" : "sequence_offset" ,
"in" : "query" ,
"required" : false ,
"type" : "string" ,
"format" : "uint64"
2020-06-25 09:25:38 +00:00
} ,
{
"name" : "asc" ,
"in" : "query" ,
"required" : false ,
"type" : "boolean" ,
"format" : "boolean"
2020-03-23 15:56:02 +00:00
}
] ,
"tags" : [
"ManagementService"
]
}
} ,
"/projects/{id}/members" : {
"post" : {
"operationId" : "AddProjectMember" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-04-15 15:11:42 +00:00
"$ref" : "#/definitions/v1ProjectMember"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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" : {
2020-04-15 15:11:42 +00:00
"$ref" : "#/definitions/v1ProjectMember"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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" : {
2020-04-21 15:00:32 +00:00
"$ref" : "#/definitions/v1ProjectRole"
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
"name" : "id" ,
"in" : "path" ,
"required" : true ,
"type" : "string"
} ,
{
"name" : "body" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/v1ProjectRoleAdd"
}
}
] ,
"tags" : [
"ManagementService"
]
}
} ,
2020-06-19 13:32:03 +00:00
"/projects/{id}/roles/_bulk" : {
"post" : {
2020-06-23 08:09:30 +00:00
"summary" : "add a list of project roles in one request" ,
2020-06-19 13:32:03 +00:00
"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"
]
}
} ,
2020-04-21 15:00:32 +00:00
"/projects/{id}/roles/{key}" : {
2020-03-23 15:56:02 +00:00
"delete" : {
2020-06-19 13:32:03 +00:00
"summary" : "RemoveProjectRole removes role from UserGrants, ProjectGrants and from Project" ,
2020-03-23 15:56:02 +00:00
"operationId" : "RemoveProjectRole" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
"properties" : { }
}
}
} ,
"parameters" : [
{
"name" : "id" ,
"in" : "path" ,
"required" : true ,
"type" : "string"
} ,
{
2020-04-21 15:00:32 +00:00
"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" ,
2020-03-23 15:56:02 +00:00
"in" : "path" ,
"required" : true ,
"type" : "string"
2020-04-21 15:00:32 +00:00
} ,
{
"name" : "body" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/v1ProjectRoleChange"
}
2020-03-23 15:56:02 +00:00
}
] ,
"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" : {
2020-06-23 05:06:07 +00:00
"$ref" : "#/definitions/v1ApplicationView"
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
"name" : "project_id" ,
"in" : "path" ,
"required" : true ,
"type" : "string"
} ,
{
"name" : "id" ,
"in" : "path" ,
"required" : true ,
"type" : "string"
}
] ,
"tags" : [
"ManagementService"
]
} ,
2020-04-21 15:00:32 +00:00
"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"
]
} ,
2020-03-23 15:56:02 +00:00
"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" : {
2020-04-23 05:54:40 +00:00
"$ref" : "#/definitions/v1ProjectGrantMember"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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" : {
2020-04-23 05:54:40 +00:00
"$ref" : "#/definitions/v1ProjectGrantMember"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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" : {
2020-06-23 05:06:07 +00:00
"$ref" : "#/definitions/v1ProjectGrantView"
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
"name" : "project_id" ,
"in" : "path" ,
"required" : true ,
"type" : "string"
} ,
{
"name" : "id" ,
"in" : "path" ,
"required" : true ,
"type" : "string"
}
] ,
"tags" : [
"ManagementService"
]
} ,
2020-04-23 05:54:40 +00:00
"delete" : {
2020-06-23 08:09:30 +00:00
"summary" : "RemoveProjectGrant removes project grant and all user grants for this project grant" ,
2020-04-23 05:54:40 +00:00
"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"
]
} ,
2020-03-23 15:56:02 +00:00
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "search user grants based on a project\nThis request is required that the user authorizations of zitadel can be differentiated" ,
2020-03-23 15:56:02 +00:00
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "create user grant based on a project\nThis request is required that the user authorizations of zitadel can be differentiated" ,
2020-03-23 15:56:02 +00:00
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "get user grant based on a project\nThis request is required that the user authorizations of zitadel can be differentiated" ,
2020-03-23 15:56:02 +00:00
"operationId" : "ProjectUserGrantByID" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-06-23 05:06:07 +00:00
"$ref" : "#/definitions/v1UserGrantView"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "update user grant based on a project\nThis request is required that the user authorizations of zitadel can be differentiated" ,
2020-03-23 15:56:02 +00:00
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "deactivate user grant based on a project\nThis request is required that the user authorizations of zitadel can be differentiated" ,
2020-03-23 15:56:02 +00:00
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "reactivate user grant based on a project\nThis request is required that the user authorizations of zitadel can be differentiated" ,
2020-03-23 15:56:02 +00:00
"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"
]
}
} ,
2020-06-19 13:32:03 +00:00
"/usergrants/_bulk" : {
"post" : {
2020-06-23 08:09:30 +00:00
"summary" : "add a list of user grants in one request" ,
2020-06-19 13:32:03 +00:00
"operationId" : "BulkCreateUserGrant" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
"properties" : { }
}
}
} ,
"parameters" : [
{
"name" : "body" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/v1UserGrantCreateBulk"
}
}
] ,
"tags" : [
"ManagementService"
]
} ,
"put" : {
2020-06-23 08:09:30 +00:00
"summary" : "update a list of user grants in one request" ,
2020-06-19 13:32:03 +00:00
"operationId" : "BulkUpdateUserGrant" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
"properties" : { }
}
}
} ,
"parameters" : [
{
"name" : "body" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/v1UserGrantUpdateBulk"
}
}
] ,
"tags" : [
"ManagementService"
]
}
} ,
2020-03-23 15:56:02 +00:00
"/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" : {
2020-06-23 08:09:30 +00:00
"summary" : "Limit should always be set, there is a default limit set by the service" ,
2020-03-23 15:56:02 +00:00
"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" : {
2020-06-17 05:25:04 +00:00
"$ref" : "#/definitions/v1UserView"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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" : {
2020-06-17 05:25:04 +00:00
"$ref" : "#/definitions/v1UserAddressView"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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" : {
2020-06-23 08:09:30 +00:00
"summary" : "UserChanges returns the event stream of the user object" ,
2020-03-23 15:56:02 +00:00
"operationId" : "UserChanges" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
"$ref" : "#/definitions/v1Changes"
}
}
} ,
"parameters" : [
{
"name" : "id" ,
"in" : "path" ,
"required" : true ,
"type" : "string"
} ,
2020-06-15 14:50:09 +00:00
{
"name" : "sec_id" ,
"in" : "query" ,
"required" : false ,
"type" : "string"
} ,
2020-03-23 15:56:02 +00:00
{
"name" : "limit" ,
"in" : "query" ,
"required" : false ,
"type" : "string" ,
"format" : "uint64"
} ,
{
"name" : "sequence_offset" ,
"in" : "query" ,
"required" : false ,
"type" : "string" ,
"format" : "uint64"
2020-06-25 09:25:38 +00:00
} ,
{
"name" : "asc" ,
"in" : "query" ,
"required" : false ,
"type" : "boolean" ,
"format" : "boolean"
2020-03-23 15:56:02 +00:00
}
] ,
"tags" : [
"ManagementService"
]
}
} ,
"/users/{id}/email" : {
"get" : {
"operationId" : "GetUserEmail" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-06-17 05:25:04 +00:00
"$ref" : "#/definitions/v1UserEmailView"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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"
]
}
} ,
2020-06-23 08:09:30 +00:00
"/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"
]
}
} ,
2020-03-23 15:56:02 +00:00
"/users/{id}/phone" : {
"get" : {
"operationId" : "GetUserPhone" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-06-17 05:25:04 +00:00
"$ref" : "#/definitions/v1UserPhoneView"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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" : {
2020-06-17 05:25:04 +00:00
"$ref" : "#/definitions/v1UserProfileView"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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" : {
2020-06-23 05:06:07 +00:00
"$ref" : "#/definitions/v1UserGrantView"
2020-03-23 15:56:02 +00:00
}
}
} ,
"parameters" : [
{
"name" : "user_id" ,
"in" : "path" ,
"required" : true ,
"type" : "string"
} ,
{
"name" : "id" ,
"in" : "path" ,
"required" : true ,
"type" : "string"
}
] ,
"tags" : [
"ManagementService"
]
} ,
2020-05-11 08:16:27 +00:00
"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"
]
} ,
2020-03-23 15:56:02 +00:00
"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"
]
}
} ,
2020-06-19 13:32:03 +00:00
"/usersgrants/_bulk" : {
"delete" : {
2020-06-23 08:09:30 +00:00
"summary" : "remove a list of user grants in one request" ,
2020-06-19 13:32:03 +00:00
"operationId" : "BulkRemoveUserGrant" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
"properties" : { }
}
}
} ,
"parameters" : [
{
"name" : "body" ,
"in" : "body" ,
"required" : true ,
"schema" : {
"$ref" : "#/definitions/v1UserGrantRemoveBulk"
}
}
] ,
"tags" : [
"ManagementService"
]
}
} ,
2020-03-23 15:56:02 +00:00
"/validate" : {
"get" : {
"operationId" : "Validate" ,
"responses" : {
"200" : {
"description" : "A successful response." ,
"schema" : {
2020-06-29 07:37:10 +00:00
"$ref" : "#/definitions/protobufStruct"
2020-03-23 15:56:02 +00:00
}
}
} ,
"tags" : [
"ManagementService"
]
}
}
} ,
"definitions" : {
2020-06-29 07:37:10 +00:00
"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."
} ,
2020-03-23 15:56:02 +00:00
"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."
} ,
2020-06-29 07:37:10 +00:00
"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."
} ,
2020-06-16 09:40:18 +00:00
"v1AddOrgDomainRequest" : {
"type" : "object" ,
"properties" : {
"domain" : {
"type" : "string"
}
}
} ,
2020-03-23 15:56:02 +00:00
"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"
2020-04-07 11:23:04 +00:00
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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" : {
2020-05-11 10:16:29 +00:00
"$ref" : "#/definitions/v1ApplicationView"
2020-03-23 15:56:02 +00:00
}
}
}
} ,
"v1ApplicationUpdate" : {
"type" : "object" ,
"properties" : {
"project_id" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
}
}
} ,
2020-05-11 10:16:29 +00:00
"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"
}
}
} ,
2020-03-23 15:56:02 +00:00
"v1Change" : {
"type" : "object" ,
"properties" : {
"change_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
"event_type" : {
"type" : "string"
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
} ,
2020-06-29 07:37:10 +00:00
"editor_id" : {
"type" : "string"
} ,
2020-04-06 04:42:21 +00:00
"editor" : {
2020-03-23 15:56:02 +00:00
"type" : "string"
} ,
"data" : {
2020-06-29 07:37:10 +00:00
"$ref" : "#/definitions/protobufStruct"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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"
} ,
2020-05-11 10:16:29 +00:00
"v1GrantedProjectSearchRequest" : {
"type" : "object" ,
"properties" : {
"offset" : {
"type" : "string" ,
"format" : "uint64"
} ,
"limit" : {
"type" : "string" ,
"format" : "uint64"
} ,
"queries" : {
"type" : "array" ,
"items" : {
2020-06-15 12:50:39 +00:00
"$ref" : "#/definitions/v1ProjectSearchQuery"
2020-05-11 10:16:29 +00:00
}
}
}
} ,
2020-06-17 05:25:04 +00:00
"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"
}
}
} ,
2020-03-23 15:56:02 +00:00
"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" ,
2020-04-21 15:00:32 +00:00
"OIDCRESPONSETYPE_TOKEN"
2020-03-23 15:56:02 +00:00
] ,
"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"
} ,
2020-06-16 09:40:18 +00:00
"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"
} ,
2020-03-23 15:56:02 +00:00
"domain" : {
"type" : "string"
2020-04-07 11:23:04 +00:00
} ,
2020-06-16 09:40:18 +00:00
"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"
} ,
2020-04-07 11:23:04 +00:00
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-03-23 15:56:02 +00:00
}
}
} ,
2020-06-19 05:27:16 +00:00
"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"
}
}
} ,
2020-03-23 15:56:02 +00:00
"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"
2020-04-07 11:23:04 +00:00
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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" : {
2020-06-10 08:47:50 +00:00
"$ref" : "#/definitions/v1OrgMemberView"
2020-03-23 15:56:02 +00:00
}
}
}
} ,
2020-06-10 08:47:50 +00:00
"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"
}
}
} ,
2020-03-23 15:56:02 +00:00
"v1OrgState" : {
"type" : "string" ,
"enum" : [
"ORGSTATE_UNSPECIFIED" ,
"ORGSTATE_ACTIVE" ,
"ORGSTATE_INACTIVE"
] ,
"default" : "ORGSTATE_UNSPECIFIED"
} ,
2020-06-23 05:06:07 +00:00
"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"
}
}
} ,
2020-03-23 15:56:02 +00:00
"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"
2020-04-07 11:23:04 +00:00
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-05-14 09:48:57 +00:00
} ,
"is_default" : {
"type" : "boolean" ,
"format" : "boolean"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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"
2020-04-07 11:23:04 +00:00
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-05-14 09:48:57 +00:00
} ,
"is_default" : {
"type" : "boolean" ,
"format" : "boolean"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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"
2020-04-07 11:23:04 +00:00
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-05-14 09:48:57 +00:00
} ,
"is_default" : {
"type" : "boolean" ,
"format" : "boolean"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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"
} ,
2020-04-07 11:23:04 +00:00
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-03-23 15:56:02 +00:00
}
}
} ,
"v1ProjectCreateRequest" : {
"type" : "object" ,
"properties" : {
"name" : {
"type" : "string"
}
}
} ,
"v1ProjectGrant" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"project_id" : {
"type" : "string"
} ,
"granted_org_id" : {
"type" : "string"
} ,
2020-04-23 05:54:40 +00:00
"role_keys" : {
2020-03-23 15:56:02 +00:00
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"state" : {
"$ref" : "#/definitions/v1ProjectGrantState"
} ,
"creation_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
"change_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
2020-04-07 11:23:04 +00:00
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-03-23 15:56:02 +00:00
}
}
} ,
"v1ProjectGrantCreate" : {
"type" : "object" ,
"properties" : {
"project_id" : {
"type" : "string"
} ,
"granted_org_id" : {
"type" : "string"
} ,
2020-04-23 05:54:40 +00:00
"role_keys" : {
2020-03-23 15:56:02 +00:00
"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"
2020-04-07 11:23:04 +00:00
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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" ,
2020-05-11 10:16:29 +00:00
"PROJECTGRANTMEMBERSEARCHKEY_USER_ID" ,
"PROJECTGRANTMEMBERSEARCHKEY_USER_NAME"
2020-03-23 15:56:02 +00:00
] ,
"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" : {
2020-05-11 10:16:29 +00:00
"$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"
2020-03-23 15:56:02 +00:00
}
2020-05-11 10:16:29 +00:00
} ,
"change_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
"creation_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-03-23 15:56:02 +00:00
}
}
} ,
2020-06-19 13:32:03 +00:00
"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"
}
}
} ,
2020-03-23 15:56:02 +00:00
"v1ProjectGrantSearchRequest" : {
"type" : "object" ,
"properties" : {
"project_id" : {
"type" : "string"
} ,
"offset" : {
"type" : "string" ,
"format" : "uint64"
} ,
"limit" : {
"type" : "string" ,
"format" : "uint64"
2020-06-19 13:32:03 +00:00
} ,
"queries" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/v1ProjectGrantSearchQuery"
}
2020-03-23 15:56:02 +00:00
}
}
} ,
"v1ProjectGrantSearchResponse" : {
"type" : "object" ,
"properties" : {
"offset" : {
"type" : "string" ,
"format" : "uint64"
} ,
"limit" : {
"type" : "string" ,
"format" : "uint64"
} ,
"total_result" : {
"type" : "string" ,
"format" : "uint64"
} ,
"result" : {
"type" : "array" ,
"items" : {
2020-05-11 10:16:29 +00:00
"$ref" : "#/definitions/v1ProjectGrantView"
2020-03-23 15:56:02 +00:00
}
}
}
} ,
"v1ProjectGrantState" : {
"type" : "string" ,
"enum" : [
"PROJECTGRANTSTATE_UNSPECIFIED" ,
"PROJECTGRANTSTATE_ACTIVE" ,
"PROJECTGRANTSTATE_INACTIVE"
] ,
"default" : "PROJECTGRANTSTATE_UNSPECIFIED"
} ,
"v1ProjectGrantUpdate" : {
"type" : "object" ,
"properties" : {
"project_id" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
2020-04-23 05:54:40 +00:00
"role_keys" : {
2020-03-23 15:56:02 +00:00
"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"
} ,
2020-04-23 05:54:40 +00:00
"role_keys" : {
2020-03-23 15:56:02 +00:00
"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"
} ,
2020-04-23 05:54:40 +00:00
"role_keys" : {
2020-03-23 15:56:02 +00:00
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
} ,
2020-05-11 10:16:29 +00:00
"v1ProjectGrantView" : {
2020-03-23 15:56:02 +00:00
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
2020-05-11 10:16:29 +00:00
} ,
"project_id" : {
2020-03-23 15:56:02 +00:00
"type" : "string"
} ,
2020-05-11 10:16:29 +00:00
"granted_org_id" : {
2020-03-23 15:56:02 +00:00
"type" : "string"
} ,
2020-05-11 10:16:29 +00:00
"granted_org_name" : {
2020-03-23 15:56:02 +00:00
"type" : "string"
} ,
2020-05-11 10:16:29 +00:00
"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"
2020-06-19 13:32:03 +00:00
} ,
"resource_owner" : {
"type" : "string"
} ,
"resource_owner_name" : {
"type" : "string"
2020-05-11 10:16:29 +00:00
}
}
} ,
"v1ProjectID" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
}
}
} ,
"v1ProjectMember" : {
"type" : "object" ,
"properties" : {
"user_id" : {
2020-03-23 15:56:02 +00:00
"type" : "string"
} ,
"roles" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"change_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
"creation_date" : {
"type" : "string" ,
"format" : "date-time"
2020-04-07 11:23:04 +00:00
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-03-23 15:56:02 +00:00
}
}
} ,
"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" ,
2020-05-11 10:16:29 +00:00
"PROJECTMEMBERSEARCHKEY_USER_ID" ,
"PROJECTMEMBERSEARCHKEY_USER_NAME"
2020-03-23 15:56:02 +00:00
] ,
"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" : {
2020-05-11 10:16:29 +00:00
"$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"
2020-03-23 15:56:02 +00:00
}
2020-05-11 10:16:29 +00:00
} ,
"change_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
"creation_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-03-23 15:56:02 +00:00
}
}
} ,
"v1ProjectRole" : {
"type" : "object" ,
"properties" : {
"project_id" : {
"type" : "string"
} ,
2020-04-21 15:00:32 +00:00
"key" : {
2020-03-23 15:56:02 +00:00
"type" : "string"
} ,
"display_name" : {
"type" : "string"
} ,
"creation_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
2020-04-21 15:00:32 +00:00
"change_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
2020-03-23 15:56:02 +00:00
"group" : {
"type" : "string"
2020-04-07 11:23:04 +00:00
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-03-23 15:56:02 +00:00
}
}
} ,
"v1ProjectRoleAdd" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
2020-04-21 15:00:32 +00:00
"key" : {
"type" : "string"
} ,
"display_name" : {
"type" : "string"
} ,
"group" : {
"type" : "string"
}
}
} ,
2020-06-19 13:32:03 +00:00
"v1ProjectRoleAddBulk" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"project_roles" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/v1ProjectRoleAdd"
}
}
}
} ,
2020-04-21 15:00:32 +00:00
"v1ProjectRoleChange" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"key" : {
2020-03-23 15:56:02 +00:00
"type" : "string"
} ,
"display_name" : {
"type" : "string"
} ,
"group" : {
"type" : "string"
}
}
} ,
"v1ProjectRoleSearchKey" : {
"type" : "string" ,
"enum" : [
"PROJECTROLESEARCHKEY_UNSPECIFIED" ,
2020-04-21 15:00:32 +00:00
"PROJECTROLESEARCHKEY_KEY" ,
2020-03-23 15:56:02 +00:00
"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" : {
2020-05-11 10:16:29 +00:00
"$ref" : "#/definitions/v1ProjectRoleView"
2020-03-23 15:56:02 +00:00
}
}
}
} ,
2020-05-11 10:16:29 +00:00
"v1ProjectRoleView" : {
2020-03-23 15:56:02 +00:00
"type" : "object" ,
"properties" : {
2020-05-11 10:16:29 +00:00
"project_id" : {
"type" : "string"
2020-03-23 15:56:02 +00:00
} ,
2020-05-11 10:16:29 +00:00
"key" : {
2020-03-23 15:56:02 +00:00
"type" : "string"
} ,
2020-05-11 10:16:29 +00:00
"display_name" : {
"type" : "string"
2020-03-23 15:56:02 +00:00
} ,
2020-05-11 10:16:29 +00:00
"creation_date" : {
2020-03-23 15:56:02 +00:00
"type" : "string" ,
2020-05-11 10:16:29 +00:00
"format" : "date-time"
2020-03-23 15:56:02 +00:00
} ,
2020-05-11 10:16:29 +00:00
"group" : {
"type" : "string"
2020-03-23 15:56:02 +00:00
} ,
2020-05-11 10:16:29 +00:00
"sequence" : {
2020-03-23 15:56:02 +00:00
"type" : "string" ,
"format" : "uint64"
}
}
} ,
2020-06-15 12:50:39 +00:00
"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"
}
}
}
} ,
2020-03-23 15:56:02 +00:00
"v1ProjectState" : {
"type" : "string" ,
"enum" : [
"PROJECTSTATE_UNSPECIFIED" ,
"PROJECTSTATE_ACTIVE" ,
2020-04-07 11:23:04 +00:00
"PROJECTSTATE_INACTIVE"
2020-03-23 15:56:02 +00:00
] ,
"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"
} ,
2020-04-23 05:54:40 +00:00
"role_keys" : {
2020-03-23 15:56:02 +00:00
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
} ,
2020-06-15 12:50:39 +00:00
"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"
}
}
} ,
2020-03-23 15:56:02 +00:00
"v1SearchMethod" : {
"type" : "string" ,
"enum" : [
"SEARCHMETHOD_EQUALS" ,
"SEARCHMETHOD_STARTS_WITH" ,
2020-05-11 10:16:29 +00:00
"SEARCHMETHOD_CONTAINS" ,
"SEARCHMETHOD_EQUALS_IGNORE_CASE" ,
"SEARCHMETHOD_STARTS_WITH_IGNORE_CASE" ,
2020-06-19 13:32:03 +00:00
"SEARCHMETHOD_CONTAINS_IGNORE_CASE" ,
"SEARCHMETHOD_NOT_EQUALS" ,
"SEARCHMETHOD_GREATER_THAN" ,
"SEARCHMETHOD_LESS_THAN" ,
"SEARCHMETHOD_IS_ONE_OF" ,
"SEARCHMETHOD_LIST_CONTAINS"
2020-03-23 15:56:02 +00:00
] ,
"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"
2020-04-07 11:23:04 +00:00
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-03-23 15:56:02 +00:00
}
}
} ,
"v1UserAddress" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"country" : {
"type" : "string"
} ,
"locality" : {
"type" : "string"
} ,
"postal_code" : {
"type" : "string"
} ,
"region" : {
"type" : "string"
} ,
"street_address" : {
"type" : "string"
2020-04-07 11:23:04 +00:00
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-05-11 08:16:27 +00:00
} ,
"creation_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
"change_date" : {
"type" : "string" ,
"format" : "date-time"
2020-03-23 15:56:02 +00:00
}
}
} ,
2020-06-17 05:25:04 +00:00
"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"
}
}
} ,
2020-03-23 15:56:02 +00:00
"v1UserEmail" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"is_email_verified" : {
"type" : "boolean" ,
"format" : "boolean"
2020-04-07 11:23:04 +00:00
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-05-11 08:16:27 +00:00
} ,
"creation_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
"change_date" : {
"type" : "string" ,
"format" : "date-time"
2020-03-23 15:56:02 +00:00
}
}
} ,
2020-06-17 05:25:04 +00:00
"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"
}
}
} ,
2020-03-23 15:56:02 +00:00
"v1UserGrant" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"user_id" : {
"type" : "string"
} ,
"org_id" : {
"type" : "string"
} ,
"project_id" : {
"type" : "string"
} ,
2020-04-23 05:54:40 +00:00
"role_keys" : {
2020-03-23 15:56:02 +00:00
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"state" : {
"$ref" : "#/definitions/v1UserGrantState"
} ,
"creation_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
"change_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
2020-04-07 11:23:04 +00:00
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-03-23 15:56:02 +00:00
}
}
} ,
"v1UserGrantCreate" : {
"type" : "object" ,
"properties" : {
"user_id" : {
"type" : "string"
} ,
"project_id" : {
"type" : "string"
} ,
2020-04-23 05:54:40 +00:00
"role_keys" : {
2020-03-23 15:56:02 +00:00
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
} ,
2020-06-19 13:32:03 +00:00
"v1UserGrantCreateBulk" : {
"type" : "object" ,
"properties" : {
"user_grants" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/v1UserGrantCreate"
}
}
}
} ,
2020-03-23 15:56:02 +00:00
"v1UserGrantID" : {
"type" : "object" ,
"properties" : {
"user_id" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
}
}
} ,
2020-06-19 13:32:03 +00:00
"v1UserGrantRemoveBulk" : {
"type" : "object" ,
"properties" : {
"ids" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
} ,
2020-03-23 15:56:02 +00:00
"v1UserGrantSearchKey" : {
"type" : "string" ,
"enum" : [
"USERGRANTSEARCHKEY_UNSPECIFIED" ,
"USERGRANTSEARCHKEY_PROJECT_ID" ,
"USERGRANTSEARCHKEY_USER_ID" ,
2020-06-19 13:32:03 +00:00
"USERGRANTSEARCHKEY_ORG_ID" ,
"USERGRANTSEARCHKEY_ROLE_KEY"
2020-03-23 15:56:02 +00:00
] ,
"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" : {
2020-05-12 04:30:53 +00:00
"$ref" : "#/definitions/v1UserGrantView"
2020-03-23 15:56:02 +00:00
}
}
}
} ,
"v1UserGrantState" : {
"type" : "string" ,
"enum" : [
"USERGRANTSTATE_UNSPECIFIED" ,
"USERGRANTSTATE_ACTIVE" ,
"USERGRANTSTATE_INACTIVE"
] ,
"default" : "USERGRANTSTATE_UNSPECIFIED"
} ,
"v1UserGrantUpdate" : {
"type" : "object" ,
"properties" : {
"user_id" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
2020-04-23 05:54:40 +00:00
"role_keys" : {
2020-03-23 15:56:02 +00:00
"type" : "array" ,
"items" : {
"type" : "string"
}
}
}
} ,
2020-06-19 13:32:03 +00:00
"v1UserGrantUpdateBulk" : {
"type" : "object" ,
"properties" : {
"user_grants" : {
"type" : "array" ,
"items" : {
"$ref" : "#/definitions/v1UserGrantUpdate"
}
}
}
} ,
2020-05-12 04:30:53 +00:00
"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"
}
}
} ,
2020-03-23 15:56:02 +00:00
"v1UserID" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
}
}
} ,
"v1UserPhone" : {
"type" : "object" ,
"properties" : {
"id" : {
"type" : "string"
} ,
"phone" : {
"type" : "string"
} ,
"is_phone_verified" : {
"type" : "boolean" ,
"format" : "boolean"
2020-04-07 11:23:04 +00:00
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-05-11 08:16:27 +00:00
} ,
"creation_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
"change_date" : {
"type" : "string" ,
"format" : "date-time"
2020-03-23 15:56:02 +00:00
}
}
} ,
2020-06-17 05:25:04 +00:00
"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"
}
}
} ,
2020-03-23 15:56:02 +00:00
"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"
2020-04-07 11:23:04 +00:00
} ,
"sequence" : {
"type" : "string" ,
"format" : "uint64"
2020-05-11 08:16:27 +00:00
} ,
"creation_date" : {
"type" : "string" ,
"format" : "date-time"
} ,
"change_date" : {
"type" : "string" ,
"format" : "date-time"
2020-03-23 15:56:02 +00:00
}
}
} ,
2020-06-17 05:25:04 +00:00
"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"
}
}
} ,
2020-03-23 15:56:02 +00:00
"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" : {
2020-05-12 04:30:53 +00:00
"$ref" : "#/definitions/v1UserView"
2020-03-23 15:56:02 +00:00
}
}
}
} ,
"v1UserState" : {
"type" : "string" ,
"enum" : [
"USERSTATE_UNSPECIFIED" ,
"USERSTATE_ACTIVE" ,
"USERSTATE_INACTIVE" ,
"USERSTATE_DELETED" ,
"USERSTATE_LOCKED" ,
"USERSTATE_SUSPEND" ,
"USERSTATE_INITIAL"
] ,
"default" : "USERSTATE_UNSPECIFIED"
2020-05-12 04:30:53 +00:00
} ,
"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"
2020-06-17 05:25:04 +00:00
} ,
"login_names" : {
"type" : "array" ,
"items" : {
"type" : "string"
}
} ,
"preferred_login_name" : {
"type" : "string"
2020-05-12 04:30:53 +00:00
}
}
2020-03-23 15:56:02 +00:00
}
}
}
