diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/eiam-developerapi/2022-02-25 | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/eiam-developerapi/2022-02-25')
| -rw-r--r-- | data/en_us/eiam-developerapi/2022-02-25/api-docs.php | 5053 |
1 files changed, 5053 insertions, 0 deletions
diff --git a/data/en_us/eiam-developerapi/2022-02-25/api-docs.php b/data/en_us/eiam-developerapi/2022-02-25/api-docs.php new file mode 100644 index 0000000..e73b29d --- /dev/null +++ b/data/en_us/eiam-developerapi/2022-02-25/api-docs.php @@ -0,0 +1,5053 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'Eiam-developerapi', + 'version' => '2022-02-25', + ], + 'directories' => [ + [ + 'id' => 404716, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ObtainCredential', + ], + ], + [ + 'id' => 404718, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ObtainCloudAccountRoleAccessCredential', + ], + ], + [ + 'id' => 404720, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GenerateToken', + 'GenerateDeviceCode', + 'GetUserInfo', + 'RevokeToken', + ], + ], + [ + 'id' => 404725, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetApplicationProvisioningScope', + ], + ], + [ + 'id' => 404727, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateOrganizationalUnit', + 'PatchOrganizationalUnit', + 'GetOrganizationalUnit', + 'DeleteOrganizationalUnit', + 'ListOrganizationalUnits', + 'ListOrganizationalUnitParentIds', + 'GetOrganizationalUnitIdByExternalId', + ], + ], + [ + 'id' => 404735, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateUser', + 'PatchUser', + 'GetUser', + 'UpdateUserPassword', + 'DeleteUser', + 'ListUsers', + 'EnableUser', + 'DisableUser', + 'GetUserIdByEmail', + 'GetUserIdByPhoneNumber', + 'GetUserIdByUserExternalId', + 'GetUserIdByUsername', + 'SetUserPrimaryOrganizationalUnit', + 'AddUserToOrganizationalUnits', + 'RemoveUserFromOrganizationalUnits', + 'ListGroupsForUser', + ], + ], + [ + 'id' => 404752, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetGroup', + 'CreateGroup', + 'PatchGroup', + 'DeleteGroup', + 'ListGroups', + 'AddUsersToGroup', + 'RemoveUsersFromGroup', + 'ListUsersForGroup', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'ObtainCredential' => [ + 'summary' => '获取凭据明文。', + 'path' => '/v2/{instanceId}/credentials/_/actions/obtain', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + 'application/json', + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREidaasDPGRH1', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。基于标准OAuth2.0或者OIDC协议签发的AccessToken', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => 'IDaaS实例ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + 'maxLength' => 64, + ], + ], + [ + 'name' => 'credentialIdentifier', + 'in' => 'query', + 'schema' => [ + 'title' => '云角色的外部唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'credential_identifier_test', + 'maxLength' => 64, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'instanceId' => [ + 'title' => 'EIAM实例ID。', + 'description' => 'EIAM实例ID。', + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + 'credentialId' => [ + 'title' => '凭据ID。', + 'description' => '凭据ID。', + 'type' => 'string', + 'example' => 'cred_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + 'status' => [ + 'title' => '凭据状态', + 'description' => '凭据状态', + 'type' => 'string', + 'example' => 'enabled', + ], + 'credentialIdentifier' => [ + 'title' => '凭据标识', + 'description' => '凭据标识', + 'type' => 'string', + 'example' => 'credential_identifier_test', + ], + 'credentialName' => [ + 'title' => '凭据名称', + 'description' => '凭据名称', + 'type' => 'string', + 'example' => 'credential_name', + ], + 'credentialSubjectType' => [ + 'title' => '凭据所属的主体类型。', + 'description' => '凭据所属的主体类型。', + 'type' => 'string', + 'example' => 'authentication_token_provider', + ], + 'credentialSubjectId' => [ + 'title' => '凭据所属的主体ID。', + 'description' => '凭据所属的主体ID。', + 'type' => 'string', + 'example' => 'apt_werthgfdsasffxxxxx', + ], + 'credentialScenarioLabel' => [ + 'title' => '凭据的使用场景标签。', + 'description' => '凭据的使用场景标签。', + 'type' => 'string', + 'example' => 'llm', + ], + 'credentialType' => [ + 'title' => '凭据类型。', + 'description' => '凭据类型。', + 'type' => 'string', + 'example' => 'api_key', + ], + 'credentialCreationType' => [ + 'title' => '凭据的创建类型。', + 'description' => '凭据的创建类型。', + 'type' => 'string', + 'example' => 'user_custom', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述', + 'type' => 'string', + 'example' => 'credential_description', + ], + 'createTime' => [ + 'title' => '云角色创建时间', + 'description' => '云角色创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649830225000', + ], + 'updateTime' => [ + 'title' => '云角色更新时间', + 'description' => '云角色更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1649830227000', + ], + 'credentialContent' => [ + 'title' => '凭据的内容', + 'description' => '凭据的内容。', + 'type' => 'object', + 'properties' => [ + 'oauthClientContent' => [ + 'title' => 'OAuth客户端认证凭证类型的凭据内容。', + 'description' => 'OAuth客户端认证凭证类型的凭据内容。', + 'type' => 'object', + 'properties' => [ + 'clientId' => [ + 'title' => 'OAuth协议的client_id', + 'description' => 'OAuth协议的client_id', + 'type' => 'string', + 'example' => 'dmvncmxersdxxxxxx', + ], + 'clientSecret' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nsklnertyt5ddwizncxxxx', + ], + ], + ], + 'apiKeyContent' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'apiKey' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'nsklncmwizncxxxx'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"instanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"credentialId\\": \\"cred_mkv7rgt4d7i4u7zqtzev2mxxxx\\",\\n \\"status\\": \\"enabled\\",\\n \\"credentialIdentifier\\": \\"credential_identifier_test\\",\\n \\"credentialName\\": \\"credential_name\\",\\n \\"credentialSubjectType\\": \\"authentication_token_provider\\",\\n \\"credentialSubjectId\\": \\"apt_werthgfdsasffxxxxx\\",\\n \\"credentialScenarioLabel\\": \\"llm\\",\\n \\"credentialType\\": \\"api_key\\",\\n \\"credentialCreationType\\": \\"user_custom\\",\\n \\"description\\": \\"credential_description\\",\\n \\"createTime\\": 1649830225000,\\n \\"updateTime\\": 1649830227000,\\n \\"credentialContent\\": {\\n \\"oauthClientContent\\": {\\n \\"clientId\\": \\"dmvncmxersdxxxxxx\\",\\n \\"clientSecret\\": \\"nsklnertyt5ddwizncxxxx\\"\\n },\\n \\"apiKeyContent\\": {\\n \\"apiKey\\": \\"nsklncmwizncxxxx\\\\n\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'ObtainCloudAccountRoleAccessCredential' => [ + 'summary' => '获取云角色（CloudAccountRole）的临时访问凭证', + 'path' => '/v2/{instanceId}/cloudAccountRoles/_/actions/obtainAccessCredential', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'consumes' => [ + 'application/x-www-form-urlencoded', + 'application/json', + 'multipart/form-data', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREidaasDPGRH1', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。基于标准OAuth2.0或者OIDC协议签发的AccessToken', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => 'IDaaS实例ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'cloudAccountRoleExternalId', + 'in' => 'query', + 'schema' => [ + 'title' => '云角色的外部唯一标识', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'acs:ram::xxx:role/role-test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'cloudAccountId' => [ + 'title' => '云账号ID', + 'description' => '', + 'type' => 'string', + 'example' => 'ca_01kmegjc11qa1txxxxx', + ], + 'cloudAccountRoleId' => [ + 'title' => '云账号角色ID', + 'description' => '', + 'type' => 'string', + 'example' => 'carole_01kmek49aqxxxx', + ], + 'cloudAccountRoleName' => [ + 'title' => '云账号角色名称', + 'description' => '', + 'type' => 'string', + 'example' => 'role-test', + ], + 'cloudAccountRoleExternalId' => [ + 'title' => '云账号角色外部唯一键', + 'description' => '', + 'type' => 'string', + 'example' => 'acs:ram::xxx:role/role-test', + ], + 'cloudAccountVendorType' => [ + 'title' => '云账号身份类型（云厂商类型）', + 'description' => '', + 'type' => 'string', + 'enumValueTitles' => [ + 'alibaba_cloud' => 'alibaba_cloud', + ], + 'example' => 'alibaba_cloud', + ], + 'cloudAccountRoleAccessCredential' => [ + 'title' => '可用于扮演云角色的临时访问凭证', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'accessCredentialExpiresAt' => [ + 'title' => '云角色临时访问凭证的过期时间，单位秒。', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1767196800', + ], + 'alibabaCloudStsToken' => [ + 'title' => '代表阿里云Role的STS Token', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'accessKeyId' => [ + 'title' => '访问密钥ID', + 'description' => '', + 'type' => 'string', + 'example' => 'STS.NUgYrLnoC37mZZCNnAbez****', + ], + 'accessKeySecret' => [ + 'title' => '访问密钥密文', + 'description' => '', + 'type' => 'string', + 'example' => 'CVwjCkNzTMupZ8NbTCxCBRq3K16jtcWFTJAyBEv2****', + ], + 'securityToken' => [ + 'title' => '临时凭证会话安全令牌', + 'description' => '', + 'type' => 'string', + 'example' => 'CAIShwJ1q6Ft5B2yfSjIr5bSEsj4g7BihPWGWHz****', + ], + 'expiration' => [ + 'title' => 'STS Token到期失效时间（UTC时间）'."\n", + 'description' => '', + 'type' => 'string', + 'example' => '2021-10-20T04:27:09Z', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"cloudAccountId\\": \\"ca_01kmegjc11qa1txxxxx\\",\\n \\"cloudAccountRoleId\\": \\"carole_01kmek49aqxxxx\\",\\n \\"cloudAccountRoleName\\": \\"role-test\\",\\n \\"cloudAccountRoleExternalId\\": \\"acs:ram::xxx:role/role-test\\",\\n \\"cloudAccountVendorType\\": \\"alibaba_cloud\\",\\n \\"cloudAccountRoleAccessCredential\\": {\\n \\"accessCredentialExpiresAt\\": 1767196800,\\n \\"alibabaCloudStsToken\\": {\\n \\"accessKeyId\\": \\"STS.NUgYrLnoC37mZZCNnAbez****\\",\\n \\"accessKeySecret\\": \\"CVwjCkNzTMupZ8NbTCxCBRq3K16jtcWFTJAyBEv2****\\",\\n \\"securityToken\\": \\"CAIShwJ1q6Ft5B2yfSjIr5bSEsj4g7BihPWGWHz****\\",\\n \\"expiration\\": \\"2021-10-20T04:27:09Z\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'GenerateToken' => [ + 'summary' => 'Generates a token for accessing an application in an instance.', + 'path' => '/v2/{instanceId}/{applicationId}/oauth2/token', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'produces' => [], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'client_id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'client_secret', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client secret. This parameter is required if grant_type is set to client_credentials.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx', + ], + ], + [ + 'name' => 'grant_type', + 'in' => 'query', + 'schema' => [ + 'title' => '授权类型', + 'description' => 'The supported authorization types are as follows:'."\n" + .'- client_credentials:Client credentials flow, requires client_id and client_secret.'."\n" + .'- refresh_token:Refresh token flow.'."\n" + .'- authorization_code:Authorization code flow.'."\n" + .'- urn:ietf:params:oauth:grant-type:device_code:Device authorization flow.'."\n" + .'- password:Password (Resource Owner Password Credentials) flow.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'client_credentials', + 'enum' => [ + 'authorization_code', + 'urn:ietf:params:oauth:grant-type:device_code', + 'refresh_token', + 'client_credentials', + 'password', + ], + ], + ], + [ + 'name' => 'code', + 'in' => 'query', + 'schema' => [ + 'title' => 'code码', + 'description' => 'The authorization code. This parameter is required if grant_type is set to authorization_code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx', + ], + ], + [ + 'name' => 'username', + 'in' => 'query', + 'schema' => [ + 'title' => '用户名', + 'description' => 'The username. This parameter is required if grant_type is set to password. The password authentication type is not supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'uesrname_001', + ], + ], + [ + 'name' => 'password', + 'in' => 'query', + 'schema' => [ + 'title' => '密码', + 'description' => 'The username. This parameter is required if grant_type is set to password. The password authentication type is not supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxxx', + ], + ], + [ + 'name' => 'device_code', + 'in' => 'query', + 'schema' => [ + 'title' => '设备码', + 'description' => 'The device code. This parameter is required if grant_type is set to authorization_code.urn:ietf:params:oauth:grant-type:device_code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx', + ], + ], + [ + 'name' => 'redirect_uri', + 'in' => 'query', + 'schema' => [ + 'title' => '重定向URI', + 'description' => 'The redirect URI. This parameter is required if grant_type is set to authorization_code. The value of this parameter must be the same as the redirect URI in the request to obtain the authorization code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'refresh_token', + 'in' => 'query', + 'schema' => [ + 'title' => '更新token', + 'description' => 'The refreshed token. This parameter is required if grant_type is set to refresh_token.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ATxxx', + ], + ], + [ + 'name' => 'code_verifier', + 'in' => 'query', + 'schema' => [ + 'title' => '验证code', + 'description' => 'The verification code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + [ + 'name' => 'exclusive_tag', + 'in' => 'query', + 'schema' => [ + 'title' => '排除的tag', + 'description' => 'The excluded tags.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ATxxx', + ], + ], + [ + 'name' => 'scope', + 'in' => 'query', + 'schema' => [ + 'title' => 'scope范围', + 'description' => 'The authorization scope. Valid values:'."\n" + ."\n" + .'* openid'."\n" + .'* email'."\n" + .'* phone'."\n" + .'* profile'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'token信息', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'token_type' => [ + 'title' => 'token类型，包含Basic,Bearer', + 'description' => 'The type of the token. Valid values: Basic Bearer'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'Basic' => 'Basic', + 'Bearer' => 'Bearer', + ], + 'example' => 'Bearer', + ], + 'access_token' => [ + 'title' => 'access_token', + 'description' => 'The access token.'."\n", + 'type' => 'string', + 'example' => 'ATxxx', + ], + 'refresh_token' => [ + 'title' => 'refresh_token', + 'description' => 'The refresh token.'."\n", + 'type' => 'string', + 'example' => 'RTxxx', + ], + 'expires_in' => [ + 'title' => '有效时长，单位秒', + 'description' => 'The remaining validity period of the token. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1200', + ], + 'expires_at' => [ + 'title' => '过期时间', + 'description' => 'The time when the token expires. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653288641', + ], + 'id_token' => [ + 'title' => 'id_token', + 'description' => 'The ID token.'."\n", + 'type' => 'string', + 'example' => 'xxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"token_type\\": \\"Bearer\\",\\n \\"access_token\\": \\"ATxxx\\",\\n \\"refresh_token\\": \\"RTxxx\\",\\n \\"expires_in\\": 1200,\\n \\"expires_at\\": 1653288641,\\n \\"id_token\\": \\"xxxxx\\"\\n}","type":"json"}]', + 'title' => 'GenerateToken', + 'description' => 'The following authorization types are supported: authorization code, device code, refresh token, and client credentials.', + ], + 'GenerateDeviceCode' => [ + 'summary' => 'Generates a device code.', + 'path' => '/v2/{instanceId}/{applicationId}/oauth2/device/code', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'scope', + 'in' => 'query', + 'schema' => [ + 'title' => 'scope范围', + 'description' => 'The authorization scope.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'DeviceCodeResponse', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'device_code' => [ + 'title' => '设备验证码', + 'description' => 'The device code.'."\n", + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'user_code' => [ + 'title' => '终端用户验证码', + 'description' => 'The user authorization code.'."\n", + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'verification_uri' => [ + 'title' => '验证URI', + 'description' => 'The verification URI.'."\n", + 'type' => 'string', + 'example' => 'https://example.com/authorize/device', + ], + 'verification_uri_complete' => [ + 'title' => '包含user_code的完整验证URI', + 'description' => 'The complete verification URI.'."\n", + 'type' => 'string', + 'example' => 'https://example.com/authorize/device?user_code='."\n" + .'xxxx', + ], + 'expires_in' => [ + 'title' => 'device_code和user_code的有效时长，单位秒', + 'description' => 'The remaining validity period of the device code. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1200', + ], + 'expires_at' => [ + 'title' => '过期时间', + 'description' => 'The time when the token expires. This value is a UNIX timestamp representing the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653288641', + ], + 'interval' => [ + 'title' => '请求token节点的超时时间，单位秒', + 'description' => 'The timeout period of the request token. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"device_code\\": \\"xxxxx\\",\\n \\"user_code\\": \\"xxxxx\\",\\n \\"verification_uri\\": \\"https://example.com/authorize/device\\",\\n \\"verification_uri_complete\\": \\"https://example.com/authorize/device?user_code=\\\\nxxxx\\",\\n \\"expires_in\\": 1200,\\n \\"expires_at\\": 1653288641,\\n \\"interval\\": 5\\n}","type":"json"}]', + 'title' => 'GenerateDeviceCode', + ], + 'GetUserInfo' => [ + 'summary' => 'Queries the information of a user by using the user token.', + 'path' => '/v2/{instanceId}/{applicationId}/oauth2/userinfo', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息，格式:Bearer access_token', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Map', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => 'The user information.'."\n", + 'example' => 'none', + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"key\\": \\"无\\"\\n}","type":"json"}]', + 'title' => 'GetUserInfo', + ], + 'RevokeToken' => [ + 'summary' => 'Revokes an access token or refresh token.', + 'path' => '/v2/{instanceId}/{applicationId}/oauth2/revoke', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'client_id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'client_secret', + 'in' => 'query', + 'schema' => [ + 'description' => 'The client secret.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CSEHDcHcrUKHw1CuxkJEHPveWRXBGqVqRsxxxx', + ], + ], + [ + 'name' => 'token', + 'in' => 'query', + 'schema' => [ + 'title' => '撤销的token', + 'description' => 'The token to be revoked.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ATxxxx', + ], + ], + [ + 'name' => 'token_type_hint', + 'in' => 'query', + 'schema' => [ + 'title' => 'token类型', + 'description' => 'The type of the token. Valid values: access_token refresh_token'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'access_token' => 'access_token', + 'refresh_token' => 'refresh_token', + ], + 'example' => 'access_token', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'RevokeResponse', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n}","type":"json"}]', + 'title' => 'RevokeToken', + ], + 'GetApplicationProvisioningScope' => [ + 'summary' => 'Queries the synchronization scope of an application in an instance.', + 'path' => '/v2/{instanceId}/{applicationId}/provisioningScope', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREidaas60YEMV', + ], + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息，格式:Bearer access_token', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => ' '."\n" + .'Bearer AT8csE2seYxxxxxij', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '同步授权范围', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'organizationalUnitIds' => [ + 'title' => '机构ID列表', + 'description' => 'The IDs of organizational units.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the organizational unit.'."\n", + 'type' => 'string', + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'example' => '[ou_xxx001]', + ], + 'groupIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"organizationalUnitIds\\": [\\n \\"ou_wovwffm62xifdziem7an7xxxxx\\"\\n ],\\n \\"groupIds\\": [\\n \\"group_wovwffm62xifdziem7an7xxxxx\\"\\n ]\\n}","type":"json"}]', + 'title' => 'GetApplicationProvisioningScope', + 'description' => '> '."\n" + ."\n" + .'* You can go to the Applications page in the IDaaS console to set the synchronization scope. After an application is created, the application has the permission to call this operation by default.'."\n", + ], + 'CreateOrganizationalUnit' => [ + 'summary' => 'Creates an organizational unit.', + 'path' => '/v2/{instanceId}/{applicationId}/organizationalUnits', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息，格式:Bearer access_token', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer AT8csE2seYxxxxxij', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'organizationalUnitName' => [ + 'title' => '机构名称', + 'description' => 'The name of the organizational unit.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'name001', + ], + 'parentId' => [ + 'title' => '父机构ID', + 'description' => 'The ID of the parent organizational unit.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'organizationalUnitExternalId' => [ + 'title' => '机构外部ID', + 'description' => 'The external ID of the organizational unit. The external ID can be used to map external data to the data of the organizational unit in Employee Identity and Access Management (EIAM) of Identity as a Service (IDaaS). By default, the external ID is the organizational unit ID.'."\n" + ."\n" + .'For organizational units with the same source type and source ID, each organizational unit has a unique external ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'description' => [ + 'title' => '描述', + 'description' => 'The description of the organizational unit.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test organizational unit', + ], + ], + 'required' => false, + 'example' => 'app_xx001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OrganizationalUnitIdObject', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'organizationalUnitId' => [ + 'title' => '机构ID', + 'description' => 'The ID of the organizational unit.'."\n", + 'type' => 'string', + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"organizationalUnitId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\"\\n}","type":"json"}]', + 'title' => 'CreateOrganizationalUnit', + ], + 'PatchOrganizationalUnit' => [ + 'summary' => 'Modifies an EIAM organizational unit.', + 'path' => '/v2/{instanceId}/{applicationId}/organizationalUnits/{organizationalUnitId}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息，格式:Bearer access_token', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => ' '."\n" + .'Bearer AT8csE2seYxxxxxij', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'organizationalUnitId', + 'in' => 'path', + 'schema' => [ + 'title' => '机构ID', + 'description' => 'The ID of the organizational unit.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'organizationalUnitName' => [ + 'title' => '机构名称', + 'description' => 'The name of the organizational unit.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name001', + ], + 'description' => [ + 'title' => '机构描述', + 'description' => 'The description of the organizational unit.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test organizational unit', + ], + ], + 'required' => false, + 'example' => 'ou_xxx001', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'PatchOrganizationalUnit', + 'description' => 'The operation conforms to the HTTP PATCH request method. The value of a parameter is modified only if the parameter is specified in the request.'."\n", + 'responseParamsDescription' => '> If the request was successful, the HTTP status code 200 is returned by default.'."\n", + ], + 'GetOrganizationalUnit' => [ + 'summary' => 'Queries the information of an organizational unit.', + 'path' => '/v2/{instanceId}/{applicationId}/organizationalUnits/{organizationalUnitId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息，格式:Bearer access_token', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer AT8csE2seYxxxxxij', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'organizationalUnitId', + 'in' => 'path', + 'schema' => [ + 'title' => '机构ID', + 'description' => 'The ID of the organizational unit.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'DeveloperOrganizationalUnitDTO', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + 'organizationalUnitId' => [ + 'title' => '机构ID', + 'description' => 'The ID of the organizational unit.'."\n", + 'type' => 'string', + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'organizationalUnitName' => [ + 'title' => '机构名称', + 'description' => 'The name of the organizational unit.'."\n", + 'type' => 'string', + 'example' => 'name001', + ], + 'parentId' => [ + 'title' => '父机构ID', + 'description' => 'The ID of the parent organizational unit.'."\n", + 'type' => 'string', + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'organizationalUnitExternalId' => [ + 'title' => '外部ID', + 'description' => 'The external ID of the organizational unit.'."\n", + 'type' => 'string', + 'example' => 'id_wovwffm62xifdziem7an7xxxxx', + ], + 'organizationalUnitSourceType' => [ + 'title' => '来源类型', + 'description' => 'The source type of the organizational unit. Valid values:'."\n" + ."\n" + .'* build_in: The organizational unit was created in Identity as a Service (IDaaS).'."\n" + .'* ding_talk: The organizational unit was imported from DingTalk.'."\n" + .'* ad: The organizational unit was imported from Microsoft Active Directory (AD).'."\n" + .'* ldap: The organizational unit was imported from a Lightweight Directory Access Protocol (LDAP) service.'."\n", + 'type' => 'string', + 'example' => 'build_in', + ], + 'organizationalUnitSourceId' => [ + 'title' => '来源ID', + 'description' => 'The source ID of the organizational unit.'."\n", + 'type' => 'string', + 'example' => 'id_wovwffm62xifdziem7an7xxxxx', + ], + 'createTime' => [ + 'title' => '创建时间，毫秒', + 'description' => 'The time when the organizational unit was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652083425923', + ], + 'updateTime' => [ + 'title' => '最近一次更新时间，毫秒', + 'description' => 'The time when the organizational unit was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652083425923', + ], + 'description' => [ + 'title' => '描述', + 'description' => 'The description of the organizational unit.'."\n", + 'type' => 'string', + 'example' => 'xxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"instanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"organizationalUnitId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"organizationalUnitName\\": \\"name001\\",\\n \\"parentId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"organizationalUnitExternalId\\": \\"id_wovwffm62xifdziem7an7xxxxx\\",\\n \\"organizationalUnitSourceType\\": \\"build_in\\",\\n \\"organizationalUnitSourceId\\": \\"id_wovwffm62xifdziem7an7xxxxx\\",\\n \\"createTime\\": 1652083425923,\\n \\"updateTime\\": 1652083425923,\\n \\"description\\": \\"xxxxx\\"\\n}","type":"json"}]', + 'title' => 'GetOrganizationalUnit', + ], + 'DeleteOrganizationalUnit' => [ + 'summary' => 'Deletes an organizational unit.', + 'path' => '/v2/{instanceId}/{applicationId}/organizationalUnits/{organizationalUnitId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息，格式:Bearer access_token', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer AT8csE2seYxxxxxij'."\n", + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'organizationalUnitId', + 'in' => 'path', + 'schema' => [ + 'title' => '机构ID', + 'description' => 'The ID of the organizational unit.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'DeleteOrganizationalUnit', + ], + 'ListOrganizationalUnits' => [ + 'summary' => 'Queries the information of Employee Identity and Access Management (EIAM) organizational units by page.', + 'path' => '/v2/{instanceId}/{applicationId}/organizationalUnits', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息，格式:Bearer access_token', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer AT8csE2seYxxxxxij'."\n", + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'parentId', + 'in' => 'query', + 'schema' => [ + 'title' => '父机构ID', + 'description' => 'The ID of the parent organizational unit.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码，默认1', + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '单页大小，默认20', + 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'GeneralDataListResponse', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '记录总数', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'data' => [ + 'description' => 'The queried organizational units.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried organizational unit.'."\n", + 'type' => 'object', + 'properties' => [ + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + 'organizationalUnitId' => [ + 'title' => '机构ID', + 'description' => 'The ID of the organizational unit.'."\n", + 'type' => 'string', + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'organizationalUnitName' => [ + 'title' => '机构名称', + 'description' => 'The name of the organizational unit.'."\n", + 'type' => 'string', + 'example' => 'name001', + ], + 'parentId' => [ + 'title' => '父机构ID', + 'description' => 'The ID of the parent organizational unit.'."\n", + 'type' => 'string', + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'organizationalUnitExternalId' => [ + 'title' => '外部ID', + 'description' => 'The external ID of the organizational unit. The external ID can be used to map external data to the data of the organizational unit in EIAM of Identity as a Service (IDaaS). By default, the external ID is the organizational unit ID.'."\n" + ."\n" + .'Note: For organizational units with the same source type and source ID, each organizational unit has a unique external ID.'."\n", + 'type' => 'string', + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'organizationalUnitSourceType' => [ + 'title' => '来源类型', + 'description' => 'The source type of the organizational unit. Valid values:'."\n" + ."\n" + .'* build_in: The organizational unit was created in IDaaS.'."\n" + .'* ding_talk: The organizational unit was imported from DingTalk.'."\n" + .'* ad: The organizational unit was imported from Microsoft Active Directory (AD).'."\n" + .'* ldap: The organizational unit was imported from a Lightweight Directory Access Protocol (LDAP) service.'."\n", + 'type' => 'string', + 'example' => 'build_in', + ], + 'organizationalUnitSourceId' => [ + 'title' => '来源ID', + 'description' => 'The source ID of the organizational unit.'."\n" + ."\n" + .'If the organizational unit was created in IDaaS, its source ID is the ID of the IDaaS instance. If the organizational unit was imported, its source ID is the enterprise ID in the source. For example, if the organizational unit was imported from DingTalk, its source ID is the corpId value of the enterprise in DingTalk.'."\n", + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + 'createTime' => [ + 'title' => '创建时间，毫秒', + 'description' => 'The time when the organizational unit was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652083425923', + ], + 'updateTime' => [ + 'title' => '最近一次更新时间，毫秒', + 'description' => 'The time when the organizational unit was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652083425923', + ], + 'description' => [ + 'title' => '描述', + 'description' => 'The description of the organizational unit.'."\n", + 'type' => 'string', + 'example' => 'test organizational unit', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 1000,\\n \\"data\\": [\\n {\\n \\"instanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"organizationalUnitId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"organizationalUnitName\\": \\"name001\\",\\n \\"parentId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"organizationalUnitExternalId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"organizationalUnitSourceType\\": \\"build_in\\",\\n \\"organizationalUnitSourceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"createTime\\": 1652083425923,\\n \\"updateTime\\": 1652083425923,\\n \\"description\\": \\"测试组织\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListOrganizationalUnits', + 'description' => "\n", + ], + 'ListOrganizationalUnitParentIds' => [ + 'summary' => 'Queries the information of all the parent organizational units of an organizational unit.', + 'path' => '/v2/{instanceId}/{applicationId}/organizationalUnits/{organizationalUnitId}/parentIds', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息，格式:Bearer access_token', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer AT8csE2seYxxxxxij', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'organizationalUnitId', + 'in' => 'path', + 'schema' => [ + 'title' => '机构ID', + 'description' => 'The ID of the organizational unit.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '父机构列表响应结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'parentIds' => [ + 'title' => '父机构ID列表，顺序层级从上到下', + 'description' => 'The IDs of the parent organizational units. The IDs of the organizational unit are ordered based on their levels from high to low. Only the IDs of the organizational units within the authorization scope are displayed.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the organizational unit.'."\n", + 'type' => 'string', + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'example' => '[ou_xxx001]', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"parentIds\\": [\\n \\"ou_wovwffm62xifdziem7an7xxxxx\\"\\n ]\\n}","type":"json"}]', + 'title' => 'ListOrganizationalUnitParentIds', + ], + 'GetOrganizationalUnitIdByExternalId' => [ + 'summary' => 'Obtains the ID of an organizational unit based on the external ID', + 'path' => '/v2/{instanceId}/{applicationId}/organizationalUnits/_/actions/getOrganizationalUnitIdByExternalId', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息，格式:Bearer access_token', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer AT8csE2seYxxxxxij'."\n", + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'organizationalUnitExternalId' => [ + 'title' => '组织外部ID', + 'description' => 'The external ID of the organizational unit. The external ID can be used to map external data to the data of the organizational unit in Employee Identity and Access Management (EIAM) of Identity as a Service (IDaaS). By default, the external ID is the organizational unit ID.'."\n" + ."\n" + .'Note: For organizational units with the same source type and source ID, each organizational unit has a unique external ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'organizationalUnitSourceType' => [ + 'title' => '组织来源类型, 取值可选范围： build_in(自建), ding_talk(钉钉导入),ad(AD导入),ldap(LDAP导入)', + 'description' => 'The source type of the organizational unit. Valid values:'."\n" + ."\n" + .'* build_in: The organizational unit was created in IDaaS.'."\n" + .'* ding_talk: The organizational unit was imported from DingTalk.'."\n" + .'* ad: The organizational unit was imported from Microsoft Active Directory (AD).'."\n" + .'* ldap: The organizational unit was imported from a Lightweight Directory Access Protocol (LDAP) service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'build_in', + ], + 'organizationalUnitSourceId' => [ + 'title' => '组织来源ID,自建类型(build_in)值为实例ID，非自建类型，为对应企业ID，比如钉钉，对应的corpId', + 'description' => 'The source ID of the organizational unit.'."\n" + ."\n" + .'If the organizational unit was created in IDaaS, its source ID is the ID of the IDaaS instance. If the organizational unit was imported, its source ID is the enterprise ID in the source. For example, if the organizational unit was imported from DingTalk, its source ID is the corpId value of the enterprise in DingTalk.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + 'required' => false, + 'example' => 'xxx001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OrganizationalUnitIdObject', + 'description' => 'OrganizationalUnitIdObject'."\n", + 'type' => 'object', + 'properties' => [ + 'organizationalUnitId' => [ + 'title' => '机构ID', + 'description' => 'The ID of the organizational unit.'."\n", + 'type' => 'string', + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"organizationalUnitId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\"\\n}","type":"json"}]', + 'title' => 'GetOrganizationalUnitIdByExternalId', + ], + 'CreateUser' => [ + 'summary' => 'Creates an Employee Identity and Access Management (EIAM) account in an organizational unit.', + 'path' => '/v2/{instanceId}/{applicationId}/users', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer AT8csE2seYxxxxxij', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'username' => [ + 'title' => '账户名称。', + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'name001', + ], + 'displayName' => [ + 'title' => '账户展示名。', + 'description' => 'The display name of the account. The display name can be up to 64 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'display_name001', + ], + 'password' => [ + 'title' => '密码, 参考密码策略', + 'description' => 'The password of the account. For information about the password rules, go to the Create User panel in the Identity as a Service (IDaaS) console.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxxxx', + ], + 'phoneRegion' => [ + 'title' => '手机地区编号,示例：中国大陆手区号为86，不带 00 或 +, 手机号若设置，此参数必填', + 'description' => 'The country code of the mobile number. For example, the country code of China is 86 without 00 or +. This parameter is required if a mobile number is specified.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '86', + ], + 'phoneNumber' => [ + 'title' => '手机号', + 'description' => 'The mobile number of the user who owns the account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '156xxxxxxx', + ], + 'phoneNumberVerified' => [ + 'title' => '手机号是否验证，手机号若设置此字段必须设置，无特殊业务可直接设置为true', + 'description' => 'Indicates whether the mobile number is verified. This field is required if a mobile number is specified. If you have no special requirement, set this parameter to true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'email' => [ + 'title' => '邮箱', + 'description' => 'The email address of the user who owns the account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + 'emailVerified' => [ + 'title' => '邮箱是否验证，邮箱若设置此字段必须设置，无特殊业务可直接设置为true', + 'description' => 'Indicates whether the email address is verified. This field is required if an email address is specified. If you have no special requirement, set this parameter to true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'userExternalId' => [ + 'title' => '账户外部ID', + 'description' => 'The external ID of the account. The external ID can be used to map external data to the data of the account in EIAM of Identity as a Service (IDaaS). By default, the external ID is the account ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + 'primaryOrganizationalUnitId' => [ + 'title' => '账户主机构ID', + 'description' => 'The ID of the primary organizational unit.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'description' => [ + 'title' => '描述', + 'description' => 'The description of the account. The description can be up to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test user', + ], + 'passwordInitializationConfig' => [ + 'title' => '密码初始化配置', + 'description' => 'Configure the initial password', + 'type' => 'object', + 'properties' => [ + 'passwordInitializationPolicyPriority' => [ + 'title' => '密码初始化策略优先级，不传不生效。枚举取值:global(全局优先)、custom(自定义优先)', + 'description' => 'Password policy', + 'type' => 'string', + 'required' => false, + 'example' => 'global', + ], + 'passwordForcedUpdateStatus' => [ + 'title' => '强制修改密码状态,默认不启用。枚举取值:enabled(开启)、disabled(禁用)', + 'description' => 'Password forced update', + 'type' => 'string', + 'required' => false, + 'example' => 'enabled', + ], + 'userNotificationChannels' => [ + 'title' => '密码通知渠道。枚举取值:email(邮件)、sms(短信)', + 'description' => 'User Notification Channels', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'email', + ], + 'required' => false, + 'example' => 'sms', + ], + 'passwordInitializationType' => [ + 'title' => '密码初始化方式。枚举取值:random(随机)', + 'description' => 'Password Initialization Type', + 'type' => 'string', + 'required' => false, + 'example' => 'random', + ], + ], + 'required' => false, + ], + 'customFields' => [ + 'title' => '扩展字段列表', + 'description' => 'Custom fields', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'fieldName' => [ + 'title' => '扩展字段标识', + 'description' => 'Field name', + 'type' => 'string', + 'required' => false, + 'example' => 'age', + ], + 'fieldValue' => [ + 'title' => '扩展字段值', + 'description' => 'Filed value', + 'type' => 'string', + 'required' => false, + 'example' => 'fieldValue_001', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + 'example' => 'app_xx001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '调用CreateUser接口在指定组织下，创建新的EIAM的账户资源', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'userId' => [ + 'title' => '账户ID。', + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"userId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\"\\n}","type":"json"}]', + 'title' => 'CreateUser', + ], + 'PatchUser' => [ + 'summary' => 'Modifies an Employee Identity and Access Management (EIAM) account.', + 'path' => '/v2/{instanceId}/{applicationId}/users/{userId}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. The value is in the Bearer ${access_token} format. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer AT8csE2seYxxxxxij', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'userId', + 'in' => 'path', + 'schema' => [ + 'title' => '账户ID', + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'username' => [ + 'title' => '账户名', + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name001', + ], + 'displayName' => [ + 'title' => '账户展示名', + 'description' => 'The display name of the account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'display_name001', + ], + 'phoneRegion' => [ + 'title' => '手机地区编号,示例：中国大陆手区号为86，不带 00 或 +, 手机号若设置，此参数必填', + 'description' => 'The country code of the mobile number. For example, the country code of China is 86 without 00 or +. This parameter is required if a mobile number is specified.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '86', + ], + 'phoneNumber' => [ + 'title' => '手机号', + 'description' => 'The mobile number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '156xxxxxxx', + ], + 'phoneNumberVerified' => [ + 'title' => '手机号是否验证，手机号若设置此字段必须设置，无特殊业务可直接设置为true', + 'description' => 'Specifies whether the mobile number is verified. This field is required if a mobile number is specified. If you have no special requirement, set this parameter to true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'email' => [ + 'title' => '邮箱', + 'description' => 'The email address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + 'emailVerified' => [ + 'title' => '邮箱是否验证，邮箱若设置此字段必须设置，无特殊业务可直接设置为true', + 'description' => 'Specifies whether the email address is verified. This field is required if an email address is specified. If you have no special requirement, set this parameter to true.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'customFields' => [ + 'title' => '扩展字段列表', + 'description' => 'The extended fields of the account.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The extended field.'."\n", + 'type' => 'object', + 'properties' => [ + 'operator' => [ + 'description' => 'The type of the operation. This parameter is deprecated. Replace it with operation.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'replace', + ], + 'fieldName' => [ + 'title' => '扩展字段标识', + 'description' => 'The name of the extended field. For more information about the type and valid values of the extended field, see the detailed description of the extended field in the IDaaS console.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'age', + ], + 'fieldValue' => [ + 'title' => '扩展字段值', + 'description' => 'The value of the extended field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_value', + ], + 'operation' => [ + 'description' => 'The operation to be performed on the field. Valid values:'."\n" + ."\n" + .'* add'."\n" + .'* replace If you leave the value of the extended field empty, the replace operation is converted to an add operation.'."\n" + .'* remove'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'replace', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + 'example' => 'user_001', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'PatchUser', + 'description' => 'The operation conforms to the HTTP PATCH request method. The value of a parameter is modified only if the parameter is specified in the request.'."\n", + ], + 'GetUser' => [ + 'summary' => 'Queries the details of an Employee Identity and Access Management (EIAM) account.', + 'path' => '/v2/{instanceId}/{applicationId}/users/{userId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. The value is in the Bearer ${access_token} format. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer AT8csE2seYxxxxxij', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'userId', + 'in' => 'path', + 'schema' => [ + 'title' => '账户ID', + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'DeveloperUserDetailDTO', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + 'organizationalUnits' => [ + 'title' => '账户所属组织列表', + 'description' => 'The organizational units to which the account belongs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The organizational unit.'."\n", + 'type' => 'object', + 'properties' => [ + 'organizationalUnitId' => [ + 'title' => '机构ID', + 'description' => 'The ID of the organizational unit.'."\n", + 'type' => 'string', + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'organizationalUnitName' => [ + 'title' => '机构名称', + 'description' => 'The name of the organizational unit.'."\n", + 'type' => 'string', + 'example' => 'name001', + ], + 'primary' => [ + 'title' => '是否主机构', + 'description' => 'Indicates whether the organizational unit is the primary organizational unit.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + 'primaryOrganizationalUnitId' => [ + 'title' => '账户主机构ID', + 'description' => 'The ID of the primary organizational unit of the account.'."\n", + 'type' => 'string', + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'customFields' => [ + 'title' => '账户扩展字段列表', + 'description' => 'The extended fields of the account.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'fieldName' => [ + 'title' => '字段标识', + 'description' => 'The name of the extended field.'."\n", + 'type' => 'string', + 'example' => 'xxxx', + ], + 'fieldValue' => [ + 'title' => '字段数据值', + 'description' => 'The value of the extended field. Field values are returned as strings regardless of the data types of the fields. For example, true or false is returned for a Boolean field.'."\n", + 'type' => 'string', + 'example' => '字段数据值', + ], + ], + ], + ], + 'userId' => [ + 'title' => '账户ID', + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + 'username' => [ + 'title' => '账户名', + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'example' => 'name001', + ], + 'displayName' => [ + 'title' => '显示名', + 'description' => 'The display name of the account.'."\n", + 'type' => 'string', + 'example' => 'display_name001', + ], + 'passwordSet' => [ + 'title' => '密码是否已设置', + 'description' => 'Indicates whether the password is set.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'phoneRegion' => [ + 'title' => '手机地区编号,示例：中国大陆手区号为86，不带 00 或 +', + 'description' => 'The country code of the mobile number. For example, the country code of China is 86 without 00 or +.'."\n", + 'type' => 'string', + 'example' => '86', + ], + 'phoneNumber' => [ + 'title' => '手机号', + 'description' => 'The mobile number of the user who owns the account.'."\n", + 'type' => 'string', + 'example' => '156xxxxxxx', + ], + 'phoneNumberVerified' => [ + 'title' => '手机号是否验证', + 'description' => 'Indicates whether the mobile number has been verified. A value of true indicates that the mobile number has been verified by the user or has been set to the verified status by the administrator. A value of false indicates that the mobile number has not been verified.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'email' => [ + 'title' => '邮箱', + 'description' => 'The email address of the user.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'emailVerified' => [ + 'title' => '邮箱是否验证', + 'description' => 'Indicates whether the email address has been verified. A value of true indicates that the email address has been verified by the user or has been set to the verified status by the administrator. A value of false indicates that the email address has not been verified.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'userExternalId' => [ + 'title' => '外部ID', + 'description' => 'The external ID of the account. The external ID can be used to map external data to the data of the account in EIAM of Identity as a Service (IDaaS). By default, the external ID is the account ID.'."\n" + ."\n" + .'Note: For accounts with the same source type and source ID, each account has a unique external ID.'."\n", + 'type' => 'string', + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + 'userSourceType' => [ + 'title' => '来源类型，build_in[自建],ding_talk[钉钉导入],ad[AD导入],ldap[LDAP导入]', + 'description' => 'The source type of the account. Valid values:'."\n" + ."\n" + .'* build_in: The account was created in IDaaS.'."\n" + .'* ding_talk: The account was imported from DingTalk.'."\n" + .'* ad: The account was imported from Microsoft Active Directory (AD).'."\n" + .'* ldap: The account was imported from a Lightweight Directory Access Protocol (LDAP) service.'."\n", + 'type' => 'string', + 'example' => 'build_in', + ], + 'userSourceId' => [ + 'title' => '来源ID', + 'description' => 'The source ID of the account.'."\n" + ."\n" + .'If the account was created in IDaaS, its source ID is the ID of the IDaaS instance. If the account was imported, its source ID is the enterprise ID in the source. For example, if the account was imported from DingTalk, its source ID is the corpId value of the enterprise in DingTalk.'."\n", + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + 'status' => [ + 'title' => '账户状态, enabled:启用,disabled:禁用', + 'description' => 'The status of the account. Valid values: enabled disabled'."\n", + 'type' => 'string', + 'example' => 'enabled', + ], + 'accountExpireTime' => [ + 'title' => '账户过期时间, 毫秒时间', + 'description' => 'The time when the account expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652085686179', + ], + 'registerTime' => [ + 'description' => 'The time when the account was registered. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652085686179', + ], + 'lockExpireTime' => [ + 'title' => '锁定过期时间, 毫秒时间', + 'description' => 'The time when the account lock expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652085686179', + ], + 'createTime' => [ + 'title' => '创建时间, 毫秒时间', + 'description' => 'The time when the account was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652085686179', + ], + 'updateTime' => [ + 'title' => '最近一次更新时间, 毫秒时间', + 'description' => 'The time when the account was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652085686179', + ], + 'description' => [ + 'title' => '账号描述', + 'description' => 'The description of the account.'."\n", + 'type' => 'string', + 'example' => 'xxxx', + ], + 'groups' => [ + 'title' => '账户所属组列表', + 'description' => 'The groups to which the account belongs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the group to which the account belongs.'."\n", + 'type' => 'object', + 'properties' => [ + 'groupId' => [ + 'title' => '组ID。', + 'description' => 'The group ID.'."\n", + 'type' => 'string', + 'example' => 'group_ufdsasn35ea5lmthk267xxxxx', + ], + 'groupName' => [ + 'title' => '组名称。', + 'description' => 'The group name.'."\n", + 'type' => 'string', + 'example' => 'name_test', + ], + 'description' => [ + 'title' => '组描述。', + 'description' => 'The group description.'."\n", + 'type' => 'string', + 'example' => 'description_demo', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"instanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"organizationalUnits\\": [\\n {\\n \\"organizationalUnitId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"organizationalUnitName\\": \\"name001\\",\\n \\"primary\\": true\\n }\\n ],\\n \\"primaryOrganizationalUnitId\\": \\"ou_wovwffm62xifdziem7an7xxxxx\\",\\n \\"customFields\\": [\\n {\\n \\"fieldName\\": \\"xxxx\\",\\n \\"fieldValue\\": \\"字段数据值\\"\\n }\\n ],\\n \\"userId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"username\\": \\"name001\\",\\n \\"displayName\\": \\"display_name001\\",\\n \\"passwordSet\\": true,\\n \\"phoneRegion\\": \\"86\\",\\n \\"phoneNumber\\": \\"156xxxxxxx\\",\\n \\"phoneNumberVerified\\": true,\\n \\"email\\": \\"[email protected]\\",\\n \\"emailVerified\\": true,\\n \\"userExternalId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"userSourceType\\": \\"build_in\\",\\n \\"userSourceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"status\\": \\"enabled\\",\\n \\"accountExpireTime\\": 1652085686179,\\n \\"registerTime\\": 1652085686179,\\n \\"lockExpireTime\\": 1652085686179,\\n \\"createTime\\": 1652085686179,\\n \\"updateTime\\": 1652085686179,\\n \\"description\\": \\"测试账户\\",\\n \\"groups\\": [\\n {\\n \\"groupId\\": \\"group_ufdsasn35ea5lmthk267xxxxx\\",\\n \\"groupName\\": \\"name_test\\",\\n \\"description\\": \\"description_demo\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetUser', + ], + 'UpdateUserPassword' => [ + 'summary' => '更新账户密码', + 'path' => '/v2/{instanceId}/{applicationId}/users/{userId}/actions/updateUserPassword', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'userId', + 'in' => 'path', + 'schema' => [ + 'title' => '账户ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'password' => [ + 'title' => '密码', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'UpdateUserPassword', + ], + 'DeleteUser' => [ + 'summary' => 'Deletes an Employee Identity and Access Management (EIAM) account.', + 'path' => '/v2/{instanceId}/{applicationId}/users/{userId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息，格式:Bearer access_token', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer AT8csE2seYxxxxxij', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'userId', + 'in' => 'path', + 'schema' => [ + 'title' => '账户ID', + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'DeleteUser', + ], + 'ListUsers' => [ + 'summary' => 'Queries the information of Employee Identity and Access Management (EIAM) accounts by page.', + 'path' => '/v2/{instanceId}/{applicationId}/users', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. The value is in the Bearer ${access_token} format. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer AT8csE2seYxxxxxij', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'organizationalUnitId', + 'in' => 'query', + 'schema' => [ + 'title' => '机构ID', + 'description' => 'The ID of the organizational unit.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + ], + [ + 'name' => 'pageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码，默认1', + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'pageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '单页大小，默认20', + 'description' => 'The number of entries per page. Default value: 20. Valid values: 1 to 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '查询账户列表响应结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'title' => '记录总数', + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'data' => [ + 'description' => 'The queried EIAM accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried EIAM account.'."\n", + 'type' => 'object', + 'properties' => [ + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + 'userId' => [ + 'title' => '账户ID', + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + 'username' => [ + 'title' => '账户名', + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'example' => 'name001', + ], + 'displayName' => [ + 'title' => '显示名', + 'description' => 'The display name of the account.'."\n", + 'type' => 'string', + 'example' => 'display_name001', + ], + 'passwordSet' => [ + 'title' => '密码是否已设置', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'phoneRegion' => [ + 'title' => '手机地区编号,示例：中国大陆手区号为86，不带 00 或 +', + 'description' => 'The country code of the mobile number. For example, the country code of China is 86 without 00 or +.'."\n", + 'type' => 'string', + 'example' => '86', + ], + 'phoneNumber' => [ + 'title' => '手机号', + 'description' => 'The mobile number of the user who owns the account.'."\n", + 'type' => 'string', + 'example' => '156xxxxxxx', + ], + 'phoneNumberVerified' => [ + 'title' => '手机号是否验证', + 'description' => 'Indicates whether the mobile number has been verified. A value of true indicates that the mobile number has been verified by the user or has been set to the verified status by the administrator. A value of false indicates that the mobile number has not been verified.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'email' => [ + 'title' => '邮箱', + 'description' => 'The email address of the user who owns the account.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + ], + 'emailVerified' => [ + 'title' => '邮箱是否验证', + 'description' => 'Indicates whether the email address has been verified. A value of true indicates that the email address has been verified by the user or has been set to the verified status by the administrator. A value of false indicates that the email address has not been verified.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'userExternalId' => [ + 'title' => '外部ID', + 'description' => 'The external ID of the account. The external ID can be used to map external data to the data of the account in EIAM of Identity as a Service (IDaaS). By default, the external ID is the account ID.'."\n" + ."\n" + .'Note: For accounts with the same source type and source ID, each account has a unique external ID.'."\n", + 'type' => 'string', + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + 'userSourceType' => [ + 'title' => '来源类型，build_in[自建],ding_talk[钉钉导入],ad[AD导入],ldap[LDAP导入]', + 'description' => 'The source type of the account. Valid values:'."\n" + ."\n" + .'* build_in: The account was created in IDaaS.'."\n" + .'* ding_talk: The account was imported from DingTalk.'."\n" + .'* ad: The account was imported from Microsoft Active Directory (AD).'."\n" + .'* ldap: The account was imported from a Lightweight Directory Access Protocol (LDAP) service.'."\n", + 'type' => 'string', + 'example' => 'build_in', + ], + 'userSourceId' => [ + 'title' => '来源ID', + 'description' => 'The source ID of the account.'."\n" + ."\n" + .'If the account was created in IDaaS, its source ID is the ID of the IDaaS instance. If the account was imported, its source ID is the enterprise ID in the source. For example, if the account was imported from DingTalk, its source ID is the corpId value of the enterprise in DingTalk.'."\n", + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + 'status' => [ + 'title' => '账户状态, enabled:启用,disabled:禁用', + 'description' => 'The status of the account. Valid values: enabled disabled'."\n", + 'type' => 'string', + 'example' => 'enabled', + ], + 'accountExpireTime' => [ + 'title' => '账户过期时间, 毫秒时间', + 'description' => 'The time when the account expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652085686179', + ], + 'registerTime' => [ + 'description' => 'The time when the account was registered. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652085686179', + ], + 'lockExpireTime' => [ + 'title' => '锁定过期时间, 毫秒时间', + 'description' => 'The time when the account lock expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652085686179', + ], + 'createTime' => [ + 'title' => '创建时间, 毫秒时间', + 'description' => 'The time when the account was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652085686179', + ], + 'updateTime' => [ + 'title' => '最近一次更新时间, 毫秒时间', + 'description' => 'The time when the account was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652085686179', + ], + 'description' => [ + 'title' => '账号描述', + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 1000,\\n \\"data\\": [\\n {\\n \\"instanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"userId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"username\\": \\"name001\\",\\n \\"displayName\\": \\"display_name001\\",\\n \\"passwordSet\\": true,\\n \\"phoneRegion\\": \\"86\\",\\n \\"phoneNumber\\": \\"156xxxxxxx\\",\\n \\"phoneNumberVerified\\": true,\\n \\"email\\": \\"[email protected]\\",\\n \\"emailVerified\\": true,\\n \\"userExternalId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"userSourceType\\": \\"build_in\\",\\n \\"userSourceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"status\\": \\"enabled\\",\\n \\"accountExpireTime\\": 1652085686179,\\n \\"registerTime\\": 1652085686179,\\n \\"lockExpireTime\\": 1652085686179,\\n \\"createTime\\": 1652085686179,\\n \\"updateTime\\": 1652085686179,\\n \\"description\\": \\"测试账户\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListUsers', + ], + 'EnableUser' => [ + 'summary' => 'Enables an Employee Identity and Access Management (EIAM) account.', + 'path' => '/v2/{instanceId}/{applicationId}/users/{userId}/actions/enable', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'userId', + 'in' => 'path', + 'schema' => [ + 'title' => '账户ID', + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user_001', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'EnableUser', + ], + 'DisableUser' => [ + 'summary' => 'Disables an Employee Identity and Access Management (EIAM) account.', + 'path' => '/v2/{instanceId}/{applicationId}/users/{userId}/actions/disable', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'userId', + 'in' => 'path', + 'schema' => [ + 'title' => '账户ID', + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'user_001', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'DisableUser', + ], + 'GetUserIdByEmail' => [ + 'summary' => 'Queries the ID of an Employee Identity and Access Management (EIAM) account by email address.', + 'path' => '/v2/{instanceId}/{applicationId}/users/_/actions/getUserIdByEmail', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息，格式:Bearer access_token', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer AT8csE2seYxxxxxij', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'email' => [ + 'title' => '邮箱', + 'description' => 'The email address of the user who owns the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'userId' => [ + 'title' => '账户ID', + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"userId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\"\\n}","type":"json"}]', + 'title' => 'GetUserIdByEmail', + ], + 'GetUserIdByPhoneNumber' => [ + 'summary' => 'Queries the ID of an Employee Identity and Access Management (EIAM) account based on the mobile number.', + 'path' => '/v2/{instanceId}/{applicationId}/users/_/actions/getUserIdByPhoneNumber', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息，格式:Bearer access_token', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer AT8csE2seYxxxxxij'."\n", + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'phoneNumber' => [ + 'title' => '手机号', + 'description' => 'The mobile number of the user who owns the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '156xxxxxxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'userId' => [ + 'title' => '账户ID', + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"userId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\"\\n}","type":"json"}]', + 'title' => 'GetUserIdByPhoneNumber', + ], + 'GetUserIdByUserExternalId' => [ + 'summary' => 'Queries the ID of an Employee Identity and Access Management (EIAM) account based on the external ID.', + 'path' => '/v2/{instanceId}/{applicationId}/users/_/actions/getUserIdByExternalId', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息，格式:Bearer access_token', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer AT8csE2seYxxxxxij', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'userExternalId' => [ + 'title' => '账户外部ID', + 'description' => 'The external ID of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'xxx001', + ], + 'userSourceType' => [ + 'title' => '账户来源类型, 取值可选范围： build_in(自建), ding_talk(钉钉导入),ad(AD导入),ldap(LDAP导入)', + 'description' => 'The source type of the account. Valid values:'."\n" + ."\n" + .'* build_in: The account was created in Identity as a Service (IDaaS).'."\n" + .'* ding_talk: The account was imported from DingTalk.'."\n" + .'* ad: The account was imported from Microsoft Active Directory (AD).'."\n" + .'* ldap: The account was imported from a Lightweight Directory Access Protocol (LDAP) service.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'build_in', + ], + 'userSourceId' => [ + 'title' => '账户来源ID,自建类型(build_in)值为实例ID，非自建类型，为对应企业ID，比如钉钉，对应的corpId', + 'description' => 'The source ID of the account. If the account was created in IDaaS, its source ID is the ID of the IDaaS instance. If the account was imported, its source ID is the enterprise ID in the source. For example, if the account was imported from DingTalk, its source ID is the corpId value of the enterprise in DingTalk.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'userId' => [ + 'title' => '账户ID', + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"userId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\"\\n}","type":"json"}]', + 'title' => 'GetUserIdByUserExternalId', + ], + 'GetUserIdByUsername' => [ + 'summary' => 'Queries the ID of an Employee Identity and Access Management (EIAM) account based on the username.', + 'path' => '/v2/{instanceId}/{applicationId}/users/_/actions/getUserIdByUsername', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. Format: Bearer ${access_token}. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'username' => [ + 'title' => '账户名。', + 'description' => 'The username of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'username_001', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '响应结果', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'userId' => [ + 'title' => '账户ID。', + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"userId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\"\\n}","type":"json"}]', + 'title' => 'GetUserIdByUsername', + ], + 'SetUserPrimaryOrganizationalUnit' => [ + 'summary' => '将指定组织设置为账户主组织，移除旧主组织，加入新主组织。', + 'path' => '/v2/{instanceId}/{applicationId}/users/{userId}/actions/setUserPrimaryOrganizationalUnit', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'userId', + 'in' => 'path', + 'schema' => [ + 'title' => '账户ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'organizationalUnitId' => [ + 'title' => '主组织ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'SetUserPrimaryOrganizationalUnit', + ], + 'AddUserToOrganizationalUnits' => [ + 'summary' => '将账户加入多个组织', + 'path' => '/v2/{instanceId}/{applicationId}/users/{userId}/actions/addUserToOrganizationalUnits', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'userId', + 'in' => 'path', + 'schema' => [ + 'title' => '账户ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'organizationalUnitIds' => [ + 'title' => '组织ID列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'required' => true, + 'example' => '[ou_wovwffm62xifdziem7an7xxxxx]', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'RemoveUserFromOrganizationalUnits' => [ + 'summary' => '将账户从多个组织移除【不支持移除主组织】', + 'path' => '/v2/{instanceId}/{applicationId}/users/{userId}/actions/removeUserFromOrganizationalUnits', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'userId', + 'in' => 'path', + 'schema' => [ + 'title' => '账户ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'organizationalUnitIds' => [ + 'title' => '组织ID列表。', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ou_wovwffm62xifdziem7an7xxxxx', + ], + 'required' => true, + 'example' => '[ou_wovwffm62xifdziem7an7xxxxx]', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + ], + 'ListGroupsForUser' => [ + 'summary' => '获取账户关联组列表', + 'path' => '/v2/{instanceId}/{applicationId}/users/{userId}/actions/listGroupsForUser', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREidaasY4QW79', + ], + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'userId', + 'in' => 'path', + 'schema' => [ + 'title' => '组ID。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'nextToken', + 'description' => 'nextToken', + 'type' => 'string', + 'required' => false, + 'example' => 'NTxxx', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '单页大小，默认20', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'DeveloperNextTokenResponse', + 'description' => 'DeveloperNextTokenResponse', + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'instanceId' => [ + 'title' => '实例ID', + 'description' => '', + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + 'groupId' => [ + 'title' => '账户ID', + 'description' => '', + 'type' => 'string', + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + 'groupMemberRelationSourceType' => [ + 'title' => '账户成员关系来源类型', + 'description' => '', + 'type' => 'string', + 'example' => 'build_in', + ], + 'groupMemberRelationSourceId' => [ + 'title' => '账户成员关系来源ID', + 'description' => '', + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + ], + ], + 'nextToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NTxxx', + ], + 'maxResults' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 1000,\\n \\"data\\": [\\n {\\n \\"instanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"groupId\\": \\"user_d6sbsuumeta4h66ec3il7yxxxx\\",\\n \\"groupMemberRelationSourceType\\": \\"build_in\\",\\n \\"groupMemberRelationSourceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\"\\n }\\n ],\\n \\"nextToken\\": \\"NTxxx\\",\\n \\"maxResults\\": 20\\n}","type":"json"}]', + ], + 'GetGroup' => [ + 'summary' => 'Queries the details of a group.', + 'path' => '/v2/{instanceId}/{applicationId}/groups/{groupId}', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREidaas1LGU5E', + ], + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. The value is in the Bearer ${access_token} format. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'title' => '组ID。', + 'description' => 'The group ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'group_wovwffm62xifdziem7an7xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'DeveloperGroupDTO', + 'description' => 'DeveloperGroupDTO'."\n", + 'type' => 'object', + 'properties' => [ + 'instanceId' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + 'groupId' => [ + 'title' => '组ID。', + 'description' => 'The group ID.'."\n", + 'type' => 'string', + 'example' => 'group_ufdsasn35ea5lmthk267xxxxx', + ], + 'groupName' => [ + 'title' => '组名称。', + 'description' => 'The group name.'."\n", + 'type' => 'string', + 'example' => 'name_test', + ], + 'description' => [ + 'title' => '组描述。', + 'description' => 'The group description.'."\n", + 'type' => 'string', + 'example' => 'description_demo', + ], + 'groupExternalId' => [ + 'title' => '组外部标识。', + 'description' => 'The external ID of the group.'."\n", + 'type' => 'string', + 'example' => 'group_ufdsasn35ea5lmthk267xxxxx', + ], + 'groupSourceType' => [ + 'title' => '组来源类型，build_in[自建],ding_talk[钉钉导入],ad[AD导入],ldap[LDAP导入]。', + 'description' => 'The source type of the group. Valid values: build_in, ding_talk, ad, and ldap.'."\n", + 'type' => 'string', + 'example' => 'build_in', + ], + 'groupSourceId' => [ + 'title' => '组来源ID。', + 'description' => 'The source ID of the group.'."\n", + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + 'createTime' => [ + 'title' => '组创建时间, Unix时间戳格式，单位为毫秒。', + 'description' => 'The time when the group was created. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652085686179', + ], + 'updateTime' => [ + 'title' => '组最近一次更新时间，Unix时间戳格式，单位为毫秒。', + 'description' => 'The time when the group was last updated. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652085686179', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"instanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"groupId\\": \\"group_ufdsasn35ea5lmthk267xxxxx\\",\\n \\"groupName\\": \\"name_test\\",\\n \\"description\\": \\"description_demo\\",\\n \\"groupExternalId\\": \\"group_ufdsasn35ea5lmthk267xxxxx\\",\\n \\"groupSourceType\\": \\"build_in\\",\\n \\"groupSourceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"createTime\\": 1652085686179,\\n \\"updateTime\\": 1652085686179\\n}","type":"json"}]', + 'title' => 'GetGroup', + ], + 'CreateGroup' => [ + 'summary' => 'Creates a group.', + 'path' => '/v2/{instanceId}/{applicationId}/groups', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREidaas7VNWU7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. The value is in the Bearer ${access_token} format. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'groupName' => [ + 'title' => '组织名称。', + 'description' => 'The organization name.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'name001', + ], + 'groupExternalId' => [ + 'title' => '外部ID。', + 'description' => 'The external ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'group_2bo6lefcewdausyyxxxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'GroupIdObject', + 'description' => 'GroupIdObject'."\n", + 'type' => 'object', + 'properties' => [ + 'groupId' => [ + 'title' => '组ID。', + 'description' => 'The group ID.'."\n", + 'type' => 'string', + 'example' => 'group_wovwffm62xifdziem7an7xxxxx', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"groupId\\": \\"group_wovwffm62xifdziem7an7xxxxx\\"\\n}","type":"json"}]', + 'title' => 'CreateGroup', + ], + 'PatchGroup' => [ + 'summary' => 'Modifies information about an Employee Identity and Access Management (EIAM) group.', + 'path' => '/v2/{instanceId}/{applicationId}/groups/{groupId}', + 'methods' => [ + 'patch', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREidaas7VNWU7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. The value is in the Bearer ${access_token} format. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'title' => '组ID', + 'description' => 'The group ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'group_xxx001', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'groupName' => [ + 'title' => '组名称', + 'description' => 'The group name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'name001', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'PatchGroup', + ], + 'DeleteGroup' => [ + 'summary' => 'Deletes a group.', + 'path' => '/v2/{instanceId}/{applicationId}/groups/{groupId}', + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREidaasJ7WKML', + 'FEATUREidaas7VNWU7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. The value is in the Bearer ${access_token} format. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'title' => '组ID。', + 'description' => 'The group ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'group_wovwffm62xifdziem7an7xxxxx', + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'DeleteGroup', + ], + 'ListGroups' => [ + 'summary' => 'Queries information about Employee Identity and Access Management (EIAM) groups by page.', + 'path' => '/v2/{instanceId}/{applicationId}/groups', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREidaas1LGU5E', + ], + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. The value is in the Bearer ${access_token} format. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'groupNameStartWith', + 'in' => 'query', + 'schema' => [ + 'title' => '组名称前缀', + 'description' => 'The prefix of the group name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'group_xxx', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'nextToken', + 'description' => 'nextToken'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NTxxx', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '单页大小，默认20', + 'description' => 'The number of entries per page. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'DeveloperNextTokenResponse', + 'description' => 'DeveloperNextTokenResponse'."\n", + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'groupName' => [ + 'title' => '组名称。', + 'description' => 'The group name.'."\n", + 'type' => 'string', + 'example' => 'name_test', + ], + 'instanceId' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + 'createTime' => [ + 'title' => '组创建时间, Unix时间戳格式，单位为毫秒。', + 'description' => 'The time when the group was created. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652085686179', + ], + 'groupId' => [ + 'title' => '组ID。', + 'description' => 'The group ID.'."\n", + 'type' => 'string', + 'example' => 'group_ufdsasn35ea5lmthk267xxxxx', + ], + 'groupSourceType' => [ + 'title' => '组来源类型，build_in[自建],ding_talk[钉钉导入],ad[AD导入],ldap[LDAP导入]。', + 'description' => 'The source type of the group. Valid values: build_in, ding_talk, ad, and ldap.'."\n", + 'type' => 'string', + 'example' => 'build_in', + ], + 'description' => [ + 'title' => '组描述。', + 'description' => 'The group description.'."\n", + 'type' => 'string', + 'example' => 'description_demo', + ], + 'groupSourceId' => [ + 'title' => '组来源ID。', + 'description' => 'The source ID of the group.'."\n", + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + 'updateTime' => [ + 'title' => '组最近一次更新时间，Unix时间戳格式，单位为毫秒。', + 'description' => 'The time when the group was last updated. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1652085686179', + ], + 'groupExternalId' => [ + 'title' => '组外部标识。', + 'description' => 'The external ID of the group.'."\n", + 'type' => 'string', + 'example' => 'group_ufdsasn35ea5lmthk267xxxxx', + ], + ], + ], + ], + 'nextToken' => [ + 'description' => 'The start position of the query. If this parameter is left empty, the query starts from the beginning.'."\n", + 'type' => 'string', + 'example' => 'NTxxx', + ], + 'maxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 1000,\\n \\"data\\": [\\n {\\n \\"groupName\\": \\"name_test\\",\\n \\"instanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"createTime\\": 1652085686179,\\n \\"groupId\\": \\"group_ufdsasn35ea5lmthk267xxxxx\\",\\n \\"groupSourceType\\": \\"build_in\\",\\n \\"description\\": \\"description_demo\\",\\n \\"groupSourceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"updateTime\\": 1652085686179,\\n \\"groupExternalId\\": \\"group_ufdsasn35ea5lmthk267xxxxx\\"\\n }\\n ],\\n \\"nextToken\\": \\"NTxxx\\",\\n \\"maxResults\\": 20\\n}","type":"json"}]', + 'title' => 'ListGroups', + ], + 'AddUsersToGroup' => [ + 'summary' => 'Adds multiple Employee Identity and Access Management (EIAM) accounts to an EIAM group. If the accounts are already added to the specified group, no update is performed.', + 'path' => '/v2/{instanceId}/{applicationId}/groups/{groupId}/actions/addUsersToGroup', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREidaasIEJFYH', + ], + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. The value is in the Bearer ${access_token} format. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'title' => '组ID。', + 'description' => 'The group ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'group_wovwffm62xifdziem7an7xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'userIds' => [ + 'title' => '账户ID列表', + 'description' => 'The account IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx', + ], + 'required' => true, + 'example' => '[user_d6sbsuumeta4h66ec3il7yxxxx}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'AddUsersToGroup', + ], + 'RemoveUsersFromGroup' => [ + 'summary' => 'Removes multiple Employee Identity and Access Management (EIAM) accounts from an EIAM group. If an account does not belong to the group, the removal succeeds by default.', + 'path' => '/v2/{instanceId}/{applicationId}/groups/{groupId}/actions/removeUsersFromGroup', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREidaasIEJFYH', + ], + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. The value is in the Bearer ${access_token} format. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'title' => '组ID。', + 'description' => 'The group ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'group_wovwffm62xifdziem7an7xxxxx', + ], + ], + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => 'The request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'userIds' => [ + 'title' => '账户ID列表', + 'description' => 'The account IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'user_d6sbsuumeta4h66ec3il7yxxxx'."\n", + ], + 'required' => true, + 'example' => '[user_d6sbsuumeta4h66ec3il7yxxxx}', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{}","type":"json"}]', + 'title' => 'RemoveUsersFromGroup', + ], + 'ListUsersForGroup' => [ + 'summary' => 'Queries accounts in an Employee Identity and Access Management (EIAM) group.', + 'path' => '/v2/{instanceId}/{applicationId}/groups/{groupId}/actions/listUsersForGroup', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'Anonymous' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREidaasSNKQAN', + ], + ], + 'parameters' => [ + [ + 'name' => 'Authorization', + 'in' => 'header', + 'schema' => [ + 'title' => '认证信息。'."\n" + .'格式:Bearer ${access_token}。'."\n" + .'示例：Bearer ATxxxx。', + 'description' => 'The authentication information. The value is in the Bearer ${access_token} format. Example: Bearer ATxxxx.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Bearer xxxx', + ], + ], + [ + 'name' => 'instanceId', + 'in' => 'path', + 'schema' => [ + 'title' => '实例ID。', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + ], + [ + 'name' => 'applicationId', + 'in' => 'path', + 'schema' => [ + 'title' => '应用ID。', + 'description' => 'The application ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'app_mkv7rgt4d7i4u7zqtzev2mxxxx', + ], + ], + [ + 'name' => 'groupId', + 'in' => 'path', + 'schema' => [ + 'title' => '组ID。', + 'description' => 'The group ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'group_wovwffm62xifdziem7an7xxxxx', + ], + ], + [ + 'name' => 'nextToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'nextToken', + 'description' => 'nextToken'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'NTxxx', + ], + ], + [ + 'name' => 'maxResults', + 'in' => 'query', + 'schema' => [ + 'title' => '单页大小，默认20', + 'description' => 'The number of entries per page. Default value: 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'DeveloperNextTokenResponse', + 'description' => 'DeveloperNextTokenResponse'."\n", + 'type' => 'object', + 'properties' => [ + 'totalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'instanceId' => [ + 'title' => '实例ID', + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'idaas_ue2jvisn35ea5lmthk267xxxxx', + ], + 'userId' => [ + 'title' => '账户ID', + 'description' => 'The account ID.'."\n", + 'type' => 'string', + 'example' => 'user_001', + ], + ], + ], + ], + 'nextToken' => [ + 'description' => 'A pagination token. If NextToken is empty, no next page exists.'."\n", + 'type' => 'string', + 'example' => 'NTxxx', + ], + 'maxResults' => [ + 'description' => 'The maximum number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 1000,\\n \\"data\\": [\\n {\\n \\"instanceId\\": \\"idaas_ue2jvisn35ea5lmthk267xxxxx\\",\\n \\"userId\\": \\"user_001\\"\\n }\\n ],\\n \\"nextToken\\": \\"NTxxx\\",\\n \\"maxResults\\": 20\\n}","type":"json"}]', + 'title' => 'ListUsersForGroup', + 'requestParamsDescription' => 'If you set groupId to iggroup_all, the system queries accounts in all groups.'."\n", + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'eiam-developerapi.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2', + 'endpoint' => 'eiam-developerapi.ap-northeast-2.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'eiam-developerapi.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'eiam-developerapi.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'eiam-developerapi.cn-hangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'eiam-developerapi.eu-central-1.aliyuncs.com', + ], + ], +]; |