{ "swagger": "2.0", "info": { "title": "admin service", "version": "0.1", "contact": { "url": "https://github.com/caos/zitadel/pkg/admin" } }, "schemes": [ "https" ], "consumes": [ "application/json", "application/grpc" ], "produces": [ "application/json", "application/grpc" ], "paths": { "/failedevents": { "get": { "operationId": "GetFailedEvents", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1FailedEvents" } } }, "tags": [ "AdminService" ] } }, "/failedevents/{database}/{view_name}/{failed_sequence}": { "delete": { "operationId": "RemoveFailedEvent", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "database", "in": "path", "required": true, "type": "string" }, { "name": "view_name", "in": "path", "required": true, "type": "string" }, { "name": "failed_sequence", "in": "path", "required": true, "type": "string", "format": "uint64" } ], "tags": [ "AdminService" ] } }, "/healthz": { "get": { "summary": "Healthz returns status OK as soon as the service started", "operationId": "Healthz", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "tags": [ "AdminService" ] } }, "/idps/_search": { "post": { "operationId": "SearchIdps", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1IdpSearchResponse" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1IdpSearchRequest" } } ], "tags": [ "AdminService" ] } }, "/idps/oidc": { "post": { "operationId": "CreateOidcIdp", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Idp" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1OidcIdpConfigCreate" } } ], "tags": [ "AdminService" ] } }, "/idps/{idp_id}/oidcconfig": { "put": { "operationId": "UpdateOidcIdpConfig", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OidcIdpConfig" } } }, "parameters": [ { "name": "idp_id", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1OidcIdpConfigUpdate" } } ], "tags": [ "AdminService" ] } }, "/idps/{id}": { "get": { "operationId": "IdpByID", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1IdpView" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" } ], "tags": [ "AdminService" ] }, "delete": { "operationId": "RemoveIdpConfig", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" } ], "tags": [ "AdminService" ] }, "put": { "operationId": "UpdateIdpConfig", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Idp" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1IdpUpdate" } } ], "tags": [ "AdminService" ] } }, "/idps/{id}/_deactivate": { "put": { "operationId": "DeactivateIdpConfig", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Idp" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1IdpID" } } ], "tags": [ "AdminService" ] } }, "/idps/{id}/_reactivate": { "put": { "operationId": "ReactivateIdpConfig", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Idp" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1IdpID" } } ], "tags": [ "AdminService" ] } }, "/members": { "post": { "operationId": "AddIamMember", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1IamMember" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1AddIamMemberRequest" } } ], "tags": [ "AdminService" ] } }, "/members/_search": { "post": { "operationId": "SearchIamMembers", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1IamMemberSearchResponse" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1IamMemberSearchRequest" } } ], "tags": [ "AdminService" ] } }, "/members/roles": { "get": { "operationId": "GetIamMemberRoles", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1IamMemberRoles" } } }, "tags": [ "AdminService" ] } }, "/members/{user_id}": { "delete": { "operationId": "RemoveIamMember", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "type": "string" } ], "tags": [ "AdminService" ] }, "put": { "operationId": "ChangeIamMember", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1IamMember" } } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1ChangeIamMemberRequest" } } ], "tags": [ "AdminService" ] } }, "/orgs/_isunique": { "get": { "summary": "ORG", "operationId": "IsOrgUnique", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1UniqueOrgResponse" } } }, "parameters": [ { "name": "name", "in": "query", "required": false, "type": "string" }, { "name": "domain", "in": "query", "required": false, "type": "string" } ], "tags": [ "AdminService" ] } }, "/orgs/_search": { "post": { "operationId": "SearchOrgs", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OrgSearchResponse" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1OrgSearchRequest" } } ], "tags": [ "AdminService" ] } }, "/orgs/_setup": { "post": { "operationId": "SetUpOrg", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OrgSetUpResponse" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1OrgSetUpRequest" } } ], "tags": [ "AdminService" ] } }, "/orgs/{id}": { "get": { "operationId": "GetOrgByID", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Org" } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" } ], "tags": [ "AdminService" ] } }, "/orgs/{org_id}/iampolicy": { "get": { "summary": "ORG_IAM_POLICY", "operationId": "GetOrgIamPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OrgIamPolicy" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string" } ], "tags": [ "AdminService" ] }, "delete": { "operationId": "DeleteOrgIamPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string" } ], "tags": [ "AdminService" ] }, "post": { "operationId": "CreateOrgIamPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OrgIamPolicy" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1OrgIamPolicyRequest" } } ], "tags": [ "AdminService" ] }, "put": { "operationId": "UpdateOrgIamPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1OrgIamPolicy" } } }, "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1OrgIamPolicyRequest" } } ], "tags": [ "AdminService" ] } }, "/policies/login": { "get": { "operationId": "GetDefaultLoginPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DefaultLoginPolicyView" } } }, "tags": [ "AdminService" ] }, "put": { "operationId": "UpdateDefaultLoginPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1DefaultLoginPolicy" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1DefaultLoginPolicy" } } ], "tags": [ "AdminService" ] } }, "/policies/login/idpproviders": { "post": { "operationId": "AddIdpProviderToDefaultLoginPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1IdpProviderID" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1IdpProviderID" } } ], "tags": [ "AdminService" ] } }, "/policies/login/idpproviders/_search": { "post": { "operationId": "GetDefaultLoginPolicyIdpProviders", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1IdpProviderSearchResponse" } } }, "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1IdpProviderSearchRequest" } } ], "tags": [ "AdminService" ] } }, "/policies/login/idpproviders/{idp_config_id}": { "post": { "operationId": "RemoveIdpProviderFromDefaultLoginPolicy", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "idp_config_id", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/v1IdpProviderID" } } ], "tags": [ "AdminService" ] } }, "/ready": { "get": { "summary": "Ready returns status OK as soon as all dependent services are available", "operationId": "Ready", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "tags": [ "AdminService" ] } }, "/validate": { "get": { "operationId": "Validate", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object" } } }, "tags": [ "AdminService" ] } }, "/views": { "get": { "operationId": "GetViews", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/v1Views" } } }, "tags": [ "AdminService" ] } }, "/views/{database}/{view_name}": { "post": { "operationId": "ClearView", "responses": { "200": { "description": "A successful response.", "schema": { "properties": {} } } }, "parameters": [ { "name": "database", "in": "path", "required": true, "type": "string" }, { "name": "view_name", "in": "path", "required": true, "type": "string" } ], "tags": [ "AdminService" ] } } }, "definitions": { "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." }, "v1AddIamMemberRequest": { "type": "object", "properties": { "user_id": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } } } }, "v1ChangeIamMemberRequest": { "type": "object", "properties": { "user_id": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } } } }, "v1CreateHumanRequest": { "type": "object", "properties": { "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" } } }, "v1CreateMachineRequest": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } } }, "v1CreateOrgRequest": { "type": "object", "properties": { "name": { "type": "string" }, "domain": { "type": "string" } } }, "v1CreateUserRequest": { "type": "object", "properties": { "user_name": { "type": "string" }, "human": { "$ref": "#/definitions/v1CreateHumanRequest" }, "machine": { "$ref": "#/definitions/v1CreateMachineRequest" } } }, "v1DefaultLoginPolicy": { "type": "object", "properties": { "allow_username_password": { "type": "boolean", "format": "boolean" }, "allow_register": { "type": "boolean", "format": "boolean" }, "allow_external_idp": { "type": "boolean", "format": "boolean" } } }, "v1DefaultLoginPolicyView": { "type": "object", "properties": { "allow_username_password": { "type": "boolean", "format": "boolean" }, "allow_register": { "type": "boolean", "format": "boolean" }, "allow_external_idp": { "type": "boolean", "format": "boolean" } } }, "v1FailedEvent": { "type": "object", "properties": { "database": { "type": "string" }, "view_name": { "type": "string" }, "failed_sequence": { "type": "string", "format": "uint64" }, "failure_count": { "type": "string", "format": "uint64" }, "error_message": { "type": "string" } } }, "v1FailedEvents": { "type": "object", "properties": { "failed_events": { "type": "array", "items": { "$ref": "#/definitions/v1FailedEvent" } } } }, "v1Gender": { "type": "string", "enum": [ "GENDER_UNSPECIFIED", "GENDER_FEMALE", "GENDER_MALE", "GENDER_DIVERSE" ], "default": "GENDER_UNSPECIFIED" }, "v1HumanResponse": { "type": "object", "properties": { "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" } } }, "v1IamMember": { "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" } } }, "v1IamMemberRoles": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } } } }, "v1IamMemberSearchKey": { "type": "string", "enum": [ "IAMMEMBERSEARCHKEY_UNSPECIFIED", "IAMMEMBERSEARCHKEY_FIRST_NAME", "IAMMEMBERSEARCHKEY_LAST_NAME", "IAMMEMBERSEARCHKEY_EMAIL", "IAMMEMBERSEARCHKEY_USER_ID" ], "default": "IAMMEMBERSEARCHKEY_UNSPECIFIED" }, "v1IamMemberSearchQuery": { "type": "object", "properties": { "key": { "$ref": "#/definitions/v1IamMemberSearchKey" }, "method": { "$ref": "#/definitions/v1SearchMethod" }, "value": { "type": "string" } } }, "v1IamMemberSearchRequest": { "type": "object", "properties": { "offset": { "type": "string", "format": "uint64" }, "limit": { "type": "string", "format": "uint64" }, "queries": { "type": "array", "items": { "$ref": "#/definitions/v1IamMemberSearchQuery" } } } }, "v1IamMemberSearchResponse": { "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/v1IamMemberView" } }, "processed_sequence": { "type": "string", "format": "uint64" }, "view_timestamp": { "type": "string", "format": "date-time" } } }, "v1IamMemberView": { "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" }, "display_name": { "type": "string" } } }, "v1Idp": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "$ref": "#/definitions/v1IdpState" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "logo_src": { "type": "string", "format": "byte" }, "oidc_config": { "$ref": "#/definitions/v1OidcIdpConfig" }, "sequence": { "type": "string", "format": "uint64" } } }, "v1IdpID": { "type": "object", "properties": { "id": { "type": "string" } } }, "v1IdpProviderID": { "type": "object", "properties": { "idp_config_id": { "type": "string" } } }, "v1IdpProviderSearchRequest": { "type": "object", "properties": { "offset": { "type": "string", "format": "uint64" }, "limit": { "type": "string", "format": "uint64" } } }, "v1IdpProviderSearchResponse": { "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/v1IdpProviderView" } }, "processed_sequence": { "type": "string", "format": "uint64" }, "view_timestamp": { "type": "string", "format": "date-time" } } }, "v1IdpProviderView": { "type": "object", "properties": { "idp_config_id": { "type": "string" }, "name": { "type": "string" }, "type": { "$ref": "#/definitions/v1IdpType" } } }, "v1IdpSearchKey": { "type": "string", "enum": [ "IDPSEARCHKEY_UNSPECIFIED", "IDPSEARCHKEY_IDP_CONFIG_ID", "IDPSEARCHKEY_NAME" ], "default": "IDPSEARCHKEY_UNSPECIFIED" }, "v1IdpSearchQuery": { "type": "object", "properties": { "key": { "$ref": "#/definitions/v1IdpSearchKey" }, "method": { "$ref": "#/definitions/v1SearchMethod" }, "value": { "type": "string" } } }, "v1IdpSearchRequest": { "type": "object", "properties": { "offset": { "type": "string", "format": "uint64" }, "limit": { "type": "string", "format": "uint64" }, "queries": { "type": "array", "items": { "$ref": "#/definitions/v1IdpSearchQuery" } } } }, "v1IdpSearchResponse": { "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/v1IdpView" } }, "processed_sequence": { "type": "string", "format": "uint64" }, "view_timestamp": { "type": "string", "format": "date-time" } } }, "v1IdpState": { "type": "string", "enum": [ "IDPCONFIGSTATE_UNSPECIFIED", "IDPCONFIGSTATE_ACTIVE", "IDPCONFIGSTATE_INACTIVE" ], "default": "IDPCONFIGSTATE_UNSPECIFIED" }, "v1IdpType": { "type": "string", "enum": [ "IDPTYPE_UNSPECIFIED", "IDPTYPE_OIDC", "IDPTYPE_SAML" ], "default": "IDPTYPE_UNSPECIFIED" }, "v1IdpUpdate": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "logo_src": { "type": "string", "format": "byte" } } }, "v1IdpView": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "$ref": "#/definitions/v1IdpState" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "logo_src": { "type": "string", "format": "byte" }, "oidc_config": { "$ref": "#/definitions/v1OidcIdpConfigView" }, "sequence": { "type": "string", "format": "uint64" } } }, "v1MachineKeyResponse": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/v1MachineKeyType" }, "sequence": { "type": "string", "format": "uint64" }, "creation_date": { "type": "string", "format": "date-time" }, "expiration_date": { "type": "string", "format": "date-time" } } }, "v1MachineKeyType": { "type": "string", "enum": [ "MACHINEKEY_UNSPECIFIED", "MACHINEKEY_JSON" ], "default": "MACHINEKEY_UNSPECIFIED" }, "v1MachineResponse": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "keys": { "type": "array", "items": { "$ref": "#/definitions/v1MachineKeyResponse" } } } }, "v1OidcIdpConfig": { "type": "object", "properties": { "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "issuer": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } } }, "v1OidcIdpConfigCreate": { "type": "object", "properties": { "name": { "type": "string" }, "logo_src": { "type": "string", "format": "byte" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "issuer": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } } }, "v1OidcIdpConfigUpdate": { "type": "object", "properties": { "idp_id": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "issuer": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } } }, "v1OidcIdpConfigView": { "type": "object", "properties": { "client_id": { "type": "string" }, "issuer": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } } }, "v1Org": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "$ref": "#/definitions/v1OrgState" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "domain": { "type": "string" } } }, "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" }, "sequence": { "type": "string", "format": "uint64" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" } } }, "v1OrgIamPolicyRequest": { "type": "object", "properties": { "org_id": { "type": "string" }, "description": { "type": "string" }, "user_login_must_be_domain": { "type": "boolean", "format": "boolean" } } }, "v1OrgSearchKey": { "type": "string", "enum": [ "ORGSEARCHKEY_UNSPECIFIED", "ORGSEARCHKEY_NAME", "ORGSEARCHKEY_DOMAIN", "ORGSEARCHKEY_STATE" ], "default": "ORGSEARCHKEY_UNSPECIFIED" }, "v1OrgSearchMethod": { "type": "string", "enum": [ "ORGSEARCHMETHOD_EQUALS", "ORGSEARCHMETHOD_STARTS_WITH", "ORGSEARCHMETHOD_CONTAINS" ], "default": "ORGSEARCHMETHOD_EQUALS" }, "v1OrgSearchQuery": { "type": "object", "properties": { "key": { "$ref": "#/definitions/v1OrgSearchKey" }, "method": { "$ref": "#/definitions/v1OrgSearchMethod" }, "value": { "type": "string" } } }, "v1OrgSearchRequest": { "type": "object", "properties": { "offset": { "type": "string", "format": "uint64" }, "limit": { "type": "string", "format": "uint64" }, "sorting_column": { "$ref": "#/definitions/v1OrgSearchKey" }, "asc": { "type": "boolean", "format": "boolean" }, "queries": { "type": "array", "items": { "$ref": "#/definitions/v1OrgSearchQuery" } } } }, "v1OrgSearchResponse": { "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/v1Org" } }, "processed_sequence": { "type": "string", "format": "uint64" }, "view_timestamp": { "type": "string", "format": "date-time" } } }, "v1OrgSetUpRequest": { "type": "object", "properties": { "org": { "$ref": "#/definitions/v1CreateOrgRequest" }, "user": { "$ref": "#/definitions/v1CreateUserRequest" } } }, "v1OrgSetUpResponse": { "type": "object", "properties": { "org": { "$ref": "#/definitions/v1Org" }, "user": { "$ref": "#/definitions/v1UserResponse" } } }, "v1OrgState": { "type": "string", "enum": [ "ORGSTATE_UNSPECIFIED", "ORGSTATE_ACTIVE", "ORGSTATE_INACTIVE" ], "default": "ORGSTATE_UNSPECIFIED" }, "v1SearchMethod": { "type": "string", "enum": [ "SEARCHMETHOD_EQUALS", "SEARCHMETHOD_STARTS_WITH", "SEARCHMETHOD_CONTAINS", "SEARCHMETHOD_EQUALS_IGNORE_CASE", "SEARCHMETHOD_STARTS_WITH_IGNORE_CASE", "SEARCHMETHOD_CONTAINS_IGNORE_CASE", "SEARCHMETHOD_NOT_EQUALS", "SEARCHMETHOD_GREATER_THAN", "SEARCHMETHOD_LESS_THAN", "SEARCHMETHOD_IS_ONE_OF", "SEARCHMETHOD_LIST_CONTAINS" ], "default": "SEARCHMETHOD_EQUALS" }, "v1UniqueOrgResponse": { "type": "object", "properties": { "is_unique": { "type": "boolean", "format": "boolean" } } }, "v1UserResponse": { "type": "object", "properties": { "id": { "type": "string" }, "state": { "$ref": "#/definitions/v1UserState" }, "creation_date": { "type": "string", "format": "date-time" }, "change_date": { "type": "string", "format": "date-time" }, "sequence": { "type": "string", "format": "uint64" }, "user_name": { "type": "string" }, "human": { "$ref": "#/definitions/v1HumanResponse" }, "machine": { "$ref": "#/definitions/v1MachineResponse" } } }, "v1UserState": { "type": "string", "enum": [ "USERSTATE_UNSPECIFIED", "USERSTATE_ACTIVE", "USERSTATE_INACTIVE", "USERSTATE_DELETED", "USERSTATE_LOCKED", "USERSTATE_SUSPEND", "USERSTATE_INITIAL" ], "default": "USERSTATE_UNSPECIFIED" }, "v1View": { "type": "object", "properties": { "database": { "type": "string" }, "view_name": { "type": "string" }, "processed_sequence": { "type": "string", "format": "uint64" }, "view_timestamp": { "type": "string", "format": "date-time" } } }, "v1Views": { "type": "object", "properties": { "views": { "type": "array", "items": { "$ref": "#/definitions/v1View" } } } } } }