# Alibaba Cloud RAM Identity Management Service API

> Alibaba Cloud RAM Identity Management Service API on Apizie: 112 endpoints (Calls AddClientIdToOIDCProvider to add a specified client ID to an OIDC IdP, Adds a fingerprint to an OpenID Connect (OIDC) identity provider (IdP), Adds a Resource Access Management (RAM) user to a RAM user group, Binds a multi-factor authentication (MFA) device to a Resource Access Management (RAM) user, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:aliyun-ims/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-ims`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/ims
- Page: https://www.apizie.tech/api/cloud/aliyun-ims
- OpenAPI: https://www.apizie.tech/api/cloud/aliyun-ims/openapi.json

Alibaba Cloud OpenAPI for RAM Identity Management Service (ims, version 2019-08-15). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Calls AddClientIdToOIDCProvider to add a specified client ID to an OIDC IdP
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/add-client-id-to-oidcprovider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| OIDCProviderName | string | no | The name of the OIDC IdP |
| ClientId | string | no | The specified client ID. Format: letters, digits, and the special characters `.-_:/` are allowed. The value cannot start with the special… |

### Adds a fingerprint to an OpenID Connect (OIDC) identity provider (IdP)
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/add-fingerprint-to-oidcprovider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| OIDCProviderName | string | no | The name of the OIDC IdP |
| Fingerprint | string | no | The fingerprint of the HTTPS CA certificate. The fingerprint can contain letters and digits. The fingerprint can be up to 128 characters… |

### Adds a Resource Access Management (RAM) user to a RAM user group
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/add-user-to-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | yes | The logon name of the RAM user |
| GroupName | string | no | The name of the RAM user group |

### Binds a multi-factor authentication (MFA) device to a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/bind-mfadevice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SerialNumber | string | no | The serial number of the MFA device. You can call the https://help.aliyun.com/document_detail/186179.html operation to obtain the serial… |
| UserPrincipalName | string | yes | The logon name of the RAM user |
| AuthenticationCode1 | string | no | The first verification code. You can call the https://help.aliyun.com/document_detail/186179.html operation to create an MFA device and… |
| AuthenticationCode2 | string | no | The second verification code. You can call the https://help.aliyun.com/document_detail/186179.html operation to create an MFA device and… |

### Changes the password that is used to log on to the console for a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/change-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| OldPassword | string | yes | The old password that is used to log on to the console |
| NewPassword | string | yes | The new password that is used to log on to the console. The password must meet the complexity requirements. For more information, see… |

### Creates an AccessKey pair for an Alibaba Cloud account or a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/create-access-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the RAM user. If this parameter is empty, an AccessKey pair is created for the current user |

### Creates an application secret for an application
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/create-app-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the application |

### Creates an application
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/create-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DisplayName | string | yes | The display name of the application. It can be up to 24 characters in length |
| AppType | string | yes | The type of the application. Valid values: WebApp: a web application that is based on browser interaction. NativeApp: a native application… |
| RedirectUris | string | no | The redirect URL of the application. To specify multiple URLs, separate them with semicolons (;) |
| SecretRequired | string | no | Specifies whether a secret is required. Valid values: true false For applications of the WebApp and ServerApp types, this parameter is… |
| AccessTokenValidity | integer | no | The validity period of the access token. Valid values: 900 to 10800. Unit: seconds. Default value: 3600 |
| RefreshTokenValidity | integer | no | The validity period of the refresh token. Valid values: 7200 to 31536000. Unit: seconds. Default value: If not specified, the default… |
| PredefinedScopes | string | no | The scope of application permissions. For more information about the application permission scope, see… |
| RequiredScopes | string | no | The required permission. You can specify one or more permissions for the `RequiredScopes` parameter. When a user grants permissions to the… |
| IsMultiTenant | string | no | Specifies whether the application can be installed by other Alibaba Cloud accounts. Valid values: true: If not specified, the default… |
| AppName | string | no | The application name. It can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (_), and hyphens (-) |
| ProtocolVersion | string | no | The OAuth protocol version of the application. Valid values: `2.0`: OAuth 2.0 `2.1`: OAuth 2.1 Default value: `2.0` |

### Creates an application assignment record to grant a specified principal the permissions to use a specified…
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/create-application-assignment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |
| PrincipalName | string | yes | The principal name of the RAM user or the role name. User principal name: The format is ` @ .onaliyun.com`. You can obtain it by calling… |
| PrincipalType | string | yes | The type of the principal to which the application is assigned. user: The principal is a RAM user. In this case, PrincipalName must be a… |

### Creates a Resource Access Management (RAM) user group
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/create-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DisplayName | string | no | The display name of the RAM user group. The name can be up to 24 characters in length |
| Comments | string | no | The description. The description can be up to 128 characters in length |
| GroupName | string | no | The name of the RAM user group. You must specify this parameter. The name can be up to 64 characters in length and can contain letters,… |

### Creates a logon configuration for a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/create-login-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | yes | The logon name of the RAM user |
| Password | string | no | The logon password for the RAM user. The password must meet the password policy |
| PasswordResetRequired | string | no | Specifies whether the RAM user must reset the password at the next logon. Valid values: true false (default) |
| MFABindRequired | string | no | Specifies whether the RAM user must enable multi-factor authentication (MFA). Valid values: true: MFA is required. The RAM user must bind… |
| Status | string | no | Specifies whether to enable password-based logon to the console. Valid values: Active (default): Enable Inactive: Disable |

### Creates an OpenID Connect (OIDC) identity provider (IdP) to configure a trust relationship between Alibaba…
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/create-oidcprovider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| OIDCProviderName | string | no | The name of the OIDC IdP. The name can contain letters, digits, and special characters and cannot start or end with the special… |
| IssuerUrl | string | no | The URL of the issuer, which is provided by the external IdP. The URL of the issuer must be unique within an Alibaba Cloud account. The… |
| Description | string | no | The description of the OIDC IdP. The description can be up to 256 characters in length |
| ClientIds | string | no | The ID of the client, which is provided by the external IdP. If you want to specify multiple client IDs, separate the client IDs with… |
| Fingerprints | string | no | The fingerprint of the HTTPS CA certificate, which is provided by the external IdP. If you want to specify multiple fingerprints, separate… |
| IssuanceLimitTime | integer | no | The earliest time when an external IdP can issue an ID token. If the value of the iat field in the ID token is later than the current… |

### Creates an identity provider (IdP) for role-based single sign-on (SSO)
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/create-samlprovider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SAMLProviderName | string | yes | The IdP name. It can be up to 128 characters in length, and can contain letters, digits, `periods (.), hyphens (-), and underscores (_)`.… |
| Description | string | no | The IdP escription |
| EncodedSAMLMetadataDocument | string | no | The metadata file, which is Base64-encoded. The file is provided by an IdP that supports Security Assertion Markup Language (SAML) 2.0 |
| AuthnSignAlgo | string | no | The supported signature algorithm. Valid values: rsa-sha256 rsa-sha1 (default) |

### Creates a service credential for a Resource Access Management (RAM) user in a specified Alibaba Cloud service
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/create-service-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the RAM user. If this parameter is left empty, the service credential is created for the current user by default |
| ServiceName | string | yes | The service name of the Alibaba Cloud service |
| ServiceCredentialName | string | yes | The name of the service credential. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), hyphens… |
| CredentialAgeDays | integer | no | The expiration period of the service credential, in days. Valid values: 1 to 36600. If this parameter is not specified, the service… |

### Creates a RAM user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/create-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | yes | The logon name of the Resource Access Management (RAM) user. The name is in the format of ` @ .onaliyun.com`. ` ` indicates the name of… |
| DisplayName | string | yes | The display name of the RAM user. The name must be 1 to 24 characters in length |
| MobilePhone | string | no | The mobile number of the RAM user. Format: Country code-Mobile phone number. This parameter is valid only on the China site (aliyun.com) |
| Email | string | no | The email address of the RAM user. This parameter is valid only on the China site (aliyun.com) |
| Comments | string | no | The description. The description must be 1 to 128 characters in length |
| Tag | string | no | The tags. You can specify up to 20 tags (JSON-encoded) |

### Creates a virtual multi-factor authentication (MFA) device
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/create-virtual-mfadevice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| VirtualMFADeviceName | string | yes | The name of the MFA device. The name must be 1 to 64 characters in length and can contain letters, digits, and hyphens (-) |

### Deletes an AccessKey pair for an Alibaba Cloud account or a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/delete-access-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserAccessKeyId | string | yes | The ID of the AccessKey pair that you want to delete |
| UserPrincipalName | string | no | The logon name of the RAM user. If this parameter is empty, the AccessKey pair of the current user is deleted |

### Deletes a specific AccessKey pair that belongs to a Resource Access Management (RAM) user from the recycle bin
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/delete-access-key-in-recycle-bin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserId | string | no | The ID of the RAM user. If you use an Alibaba Cloud account to call the operation, you must specify the parameter. If you use a RAM user… |
| UserAccessKeyId | string | no | The AccessKey ID of the RAM user |

### Deletes the application secret of an application
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/delete-app-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the application |
| AppSecretId | string | yes | The ID of the application secret |

### Deletes an application
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/delete-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the application |

### Deletes an application allocation record and revokes the permissions of a specified principal to use a…
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/delete-application-assignment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |
| PrincipalName | string | yes | The principal name of the RAM user or the role name. User principal name: The format is ` @ .onaliyun.com`. You can query the name by… |
| PrincipalType | string | yes | The type of the target principal for the application allocation. Valid values: user: The principal type is RAM user. In this case,… |

### Deletes a Resource Access Management (RAM) user group
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/delete-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GroupName | string | no | The name of the RAM user group |

### Disables logon to the console for a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/delete-login-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | yes | The logon name of the RAM user |

### Deletes an OpenID Connect (OIDC) identity provider (IdP)
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/delete-oidcprovider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| OIDCProviderName | string | no | The name of the OIDC IdP |

### Deletes the passkey of a user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/delete-passkey` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the Resource Access Management (RAM) user |
| PasskeyId | string | no | The ID of the passkey. This parameter is actually required. If you do not specify this parameter, the call fails and the error code… |

### Deletes an identity provider (IdP) for role-based single sign-on (SSO)
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/delete-samlprovider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SAMLProviderName | string | yes | The name of the IdP that you want to delete |

### Deletes the service credential of a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/delete-service-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ServiceCredentialId | string | yes | The service credential ID |
| UserPrincipalName | string | no | The logon name of the Resource Access Management (RAM) user. If this parameter is not specified, the service credential of the identity… |

### Deletes a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/delete-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the RAM user. You must specify only one of the following parameters: `UserPrincipalName` and `UserId` |
| UserId | string | no | The ID of the RAM user. You must specify only one of the following parameters: `UserPrincipalName` and `UserId` |

### Deletes a specific Resource Access Management (RAM) user from the recycle bin
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/delete-user-in-recycle-bin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserId | string | no | The ID of the RAM user |

### Deletes a multi-factor authentication (MFA) device
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/delete-virtual-mfadevice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SerialNumber | string | yes | The serial number of the MFA device |

### Uninstalls an external application or an internal application of the ServerApp type
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/deprovision-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the application |

### Deletes an installed external application
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/deprovision-external-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the application |

### Unbinds and deletes a multi-factor authentication (MFA) device from a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/disable-virtual-mfa` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | yes | The logon name of the RAM user |

### Generates the user credential report of an Alibaba Cloud account
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/generate-credential-report` (byok)

### Generates a check report for Cloud Governance
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/generate-governance-report` (byok)

### Queries information about a specific AccessKey pair of a Resource Access Management (RAM) user in the…
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-access-key-info-in-recycle-bin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserAccessKeyId | string | yes | The AccessKey ID of the Resource Access Management (RAM) user |

### Queries the time when an AccessKey pair was used for the last time
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-access-key-last-used` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the RAM user. If you do not specify this parameter, the AccessKey pair of the current user is queried |
| UserAccessKeyId | string | yes | The ID of the AccessKey pair that you want to query |

### Queries the network access restriction policy of an access key for an Alibaba Cloud account or a Resource…
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-access-key-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the RAM user. If this parameter is left empty, the network access restriction policy of the specified access key for the… |
| UserAccessKeyId | string | yes | The access key ID |

### Queries the account-level AccessKey network access control policy
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-access-key-policy-for-account` (byok)

### Queries information about the multi-factor authentication (MFA) devices of an Alibaba Cloud account
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-account-mfainfo` (byok)

### Queries the security report of an Alibaba Cloud account
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-account-security-practice-report` (byok)

### Queries the overview information of an Alibaba Cloud account
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-account-summary` (byok)

### Queries the details of an application secret
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-app-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the application |
| AppSecretId | string | yes | The ID of the application secret |

### Queries the configuration information of an application
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |

### Queries the installation information of a specified installed application
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-application-provision-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the application. You can call ListApplicationProvisionInfos to obtain the AppId of an installed application |

### Queries the user credential reports of an Alibaba Cloud account
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-credential-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| NextToken | string | no | The token that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate… |
| MaxItems | string | no | The number of entries per page. If a response is truncated because it reaches the value of `MaxItems`, the value of `IsTruncated` will be… |

### Queries the default domain name of an Alibaba Cloud account
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-default-domain` (byok)

### Queries information about an installed external application
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-external-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the application |

### Queries the details of a specific check item in an identity and access governance report
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-governance-item-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GovernanceItemType | string | no | The check item. For more information, see Identity and access governance check items… |
| Marker | string | no | If the response is truncated, use the `Marker` to retrieve the subsequent content |
| MaxItems | string | no | The number of entries to return. If the response is truncated because the number of entries exceeds the value of `MaxItems`, the value of… |

### Retrieves the current generation status of an identity and access governance report
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-governance-report-status` (byok)

### Queries the information about a Resource Access Management (RAM) user group
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GroupName | string | no | The name of the RAM user group |

### Queries the console logon settings for a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-login-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | yes | The logon name of the RAM user |

### Queries the information about an OIDC IdP
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-oidcprovider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| OIDCProviderName | string | no | The name of the OIDC IdP |

### Queries the password policy for Resource Access Management (RAM) users
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-password-policy` (byok)

### Queries the details of a specified role-based SSO identity provider
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-samlprovider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SAMLProviderName | string | yes | The name of the identity provider. You can call ListSAMLProviders to view existing identity providers or CreateSAMLProvider to create a… |

### Use `GetSecurityPreference` to query the global security preferences of a RAM user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-security-preference` (byok)

### Retrieves a specific service credential of a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-service-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ServiceCredentialId | string | yes | The service credential ID |
| UserPrincipalName | string | no | The logon name of the Resource Access Management (RAM) user. If not specified, the service credential of the current identity that invokes… |

### Queries the information about a RAM user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the RAM user. The name is in the format of ` @ .onaliyun.com`. ` ` indicates the name of the RAM user. ` .onaliyun.com`… |
| UserId | string | no | The ID of the RAM user. You must specify only one of the following parameters: `UserPrincipalName`, `UserId`, and `UserAccessKeyId` |
| UserAccessKeyId | string | no | The AccessKey ID of the RAM user. You must specify only one of the following parameters: `UserPrincipalName`, `UserId`, and… |

### Queries information about a specific Resource Access Management (RAM) user in the recycle bin
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-user-in-recycle-bin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserId | string | no | The ID of the RAM user. You must specify only one of the following parameters: `UserId` and `UserAccessKeyId` |
| UserAccessKeyId | string | no | The AccessKey ID of the RAM user. You must specify only one of the following parameters: `UserId` and `UserAccessKeyId` |

### Queries information about the multi-factor authentication (MFA) device that is bound to a Resource Access…
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-user-mfainfo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the RAM user. This parameter is differently set in the following scenarios: If you use a RAM user to call this… |

### Queries the configurations of user-based single sign-on (SSO)
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-user-sso-settings` (byok)

### Queries the status of the secure phone or security email address of a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/get-verification-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the Resource Access Management (RAM) user |

### Queries the AccessKey pairs of an Alibaba Cloud account or a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-access-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the RAM user. If this parameter is empty, the AccessKey pairs of the current user are queried |

### Queries the AccessKey pairs of a specific Resource Access Management (RAM) user in the recycle bin
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-access-keys-in-recycle-bin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserId | string | no | The ID of the Resource Access Management (RAM) user |

### Queries the secret IDs of an application
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-app-secret-ids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the application |

### Lists the assignment records of a specified application
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-application-assignments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |
| NextToken | string | no | The token used to retrieve the next page of query results. This parameter is not required for the first API call |
| MaxResults | integer | no | The maximum number of entries per page |

### Lists the application assignment records for a specified principal
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-application-assignments-for-principal` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| NextToken | string | no | The token used to retrieve the next page of query results. This parameter is not required for the first API call |
| MaxResults | integer | no | The maximum number of entries per page |
| PrincipalName | string | no | The principal name of the RAM user or the role name. User principal name: The format is ` @ .onaliyun.com`. You can obtain it by calling… |
| PrincipalType | string | no | The type of the principal to which the application is assigned. user: The principal is a RAM user. In this case, PrincipalName must be the… |

### Queries the installation information of all installed applications
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-application-provision-infos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SourceType | string | no | The source type of the application. Valid values: inner: applications from the current account. external: applications from other accounts |

### Lists the applications that you have created
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-applications` (byok)

### Queries information about all installed external applications
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-external-applications` (byok)

### Queries Resource Access Management (RAM) user groups
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Marker | string | no | The `marker`. If part of a previous response is truncated, you can use this parameter to obtain the truncated part |
| MaxItems | integer | no | The number of entries to return. If a response is truncated because it reaches the value of `MaxItems`, the value of `IsTruncated` will be… |

### Queries the Resource Access Management (RAM) user groups to which a RAM user belongs
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-groups-for-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | yes | The logon name of the RAM user |

### Queries OIDC IdPs
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-oidcproviders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Marker | string | no | The `marker`. If part of a previous response is truncated, you can use this parameter to obtain the truncated part |
| MaxItems | integer | no | The number of entries per page. If a response is truncated because it reaches the value of `MaxItems`, the value of `IsTruncated` will be… |

### Queries the information about the passkeys that are bound to a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-passkeys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the RAM user |

### Queries predefined application permissions
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-predefined-scopes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppType | string | no | The type of the application. Valid values: WebApp NativeApp ServerApp If this parameter is empty, the permissions on all types of… |

### Queries all metric values in the most recent governance check
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-recent-governance-metrics` (byok)

### Queries information about identity providers (IdPs) for role-based single sign-on (SSO)
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-samlproviders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Marker | string | no | The `marker`. If part of a previous response is truncated, you can use this parameter to obtain the truncated part |
| MaxItems | integer | no | The number of entries to return. If a response is truncated because it reaches the value of `MaxItems`, the value of `IsTruncated` will be… |

### Retrieves the list of service credentials for a Resource Access Management (RAM) user or all Resource Access…
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-service-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AllUsers | string | no | Specifies whether to query service credentials for all Resource Access Management (RAM) users under the Alibaba Cloud account. When the… |
| UserPrincipalName | string | no | The logon name of the Resource Access Management (RAM) user. Queries the service credentials of the specified RAM user |
| ServiceName | string | no | The Alibaba Cloud service name |
| MaxResults | integer | no | The maximum number of entries per page. Valid values: 1 to 100. Default value: 10 |
| NextToken | string | no | The token used to retrieve the next page of results. This parameter is not required for the first API call |

### Queries the tags that are added resources
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourcePrincipalName | string | no | The name of resource N. Valid values of N: 1 to 50. If ResourceType is set to user, the resource name is the name of the RAM user. You… |
| NextToken | string | no | The token that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate… |
| PageSize | integer | no | The number of entries per page. If a response is truncated because it reaches the value of PageSize, the value of IsTruncated will be… |
| ResourceType | string | no | The type of the resource. Valid value: user: a RAM user |
| ResourceId | string | no | The ID of resource N. Valid values of N: 1 to 50. If ResourceType is set to user, the resource ID is the ID of the RAM user. You must… |
| Tag | string | no | The tag value. Valid values of N: 1 to 20. N must be consecutive (JSON-encoded) |

### Queries the basic information about all Resource Access Management (RAM) users
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-user-basic-infos` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Marker | string | no | The `marker`. If part of a previous response is truncated, you can use this parameter to obtain the truncated part |
| MaxItems | integer | no | The number of entries to return. If a response is truncated because it reaches the value of `MaxItems`, the value of `IsTruncated` will be… |
| Tag | string | no | The tags (JSON-encoded) |
| Status | string | no | The status of the RAM users that you want to query. Valid values: active, freeze, and active,freeze. If you set the value to… |

### Queries information about all Resource Access Management (RAM) users
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Marker | string | no | The `marker`. If part of a previous response is truncated, you can use this parameter to obtain the truncated part |
| MaxItems | integer | no | The number of entries per page. If a response is truncated because it reaches the value of `MaxItems`, the value of `IsTruncated` will be… |
| Tag | string | no | The tags. A maximum number of 20 tags are supported (JSON-encoded) |
| Status | string | no | The status of the RAM users that you want to query. Valid values: active, freeze, and active,freeze. If you leave the parameter empty, the… |

### Queries Resource Access Management (RAM) users in a RAM user group
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-users-for-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| GroupName | string | no | The name of the RAM user group |
| Marker | string | no | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the… |
| MaxItems | integer | no | The number of entries per page. Valid values: 1 to 100. Default value: 100 |

### Queries the basic information about all Resource Access Management (RAM) users in the recycle bin
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-users-in-recycle-bin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Marker | string | no | The `marker`. If part of a previous response is truncated, you can use this parameter to obtain the truncated part |
| MaxItems | integer | no | The number of entries to return. If a response is truncated because it reaches the value of `MaxItems`, the value of `IsTruncated` will be… |
| Filter | string | no | The filter condition that is used to query information about a specified RAM user in the recycle bin. You must specify this parameter in… |

### Queries the list of multi-factor authentication devices
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/list-virtual-mfadevices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Marker | string | no | The token for querying the next page of results. You do not need to specify `Marker` for the first API call. When you call the API for the… |
| MaxItems | integer | no | The maximum number of entries per page. Valid values: 1 to 100. Default value: 100 |

### Installs an application
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/provision-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the application |
| Scopes | string | no | The permissions that are granted to the application. Separate multiple permissions with a semicolon (;). For more information about the… |

### Installs an external application
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/provision-external-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The ID of the external application that was created by another Alibaba Cloud account and can be installed by the current account. The… |
| Scopes | string | no | The permission scopes granted to the application. You can specify multiple scopes separated by semicolons (;). For supported permission… |

### Invokes RemoveClientIdFromOIDCProvider to remove a specified client ID from an OIDC IdP
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/remove-client-id-from-oidcprovider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| OIDCProviderName | string | no | The name of the OIDC IdP that exists and is bound to the target `ClientId`. If the OIDC IdP has not been created or the client ID has not… |
| ClientId | string | no | The specified client ID. Format: The client ID can contain letters, digits, and the following special characters: `.-_:/`. It cannot start… |

### Removes a fingerprint from an OpenID Connect (OIDC) identity provider (IdP)
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/remove-fingerprint-from-oidcprovider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| OIDCProviderName | string | no | The name of the OIDC IdP |
| Fingerprint | string | no | The fingerprint that you want to remove |

### Removes a Resource Access Management (RAM) user from a RAM user group
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/remove-user-from-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | yes | The logon name of the RAM user |
| GroupName | string | no | The name of the RAM user group |

### Restores a specific AccessKey pair that belongs to a Resource Access Management (RAM) user from the recycle…
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/restore-access-key-from-recycle-bin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserId | string | no | The ID of the Resource Access Management (RAM) user |
| UserAccessKeyId | string | no | The AccessKey ID of the RAM user |

### Restores a specific Resource Access Management (RAM) user from the recycle bin
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/restore-user-from-recycle-bin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserId | string | no | The ID of the RAM user |

### Settings the network access restriction policy for an access key of an Alibaba Cloud account or a Resource…
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/set-access-key-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the RAM user. If this parameter is left empty, the network access restriction policy is set for the specified access key… |
| UserAccessKeyId | string | yes | The access key ID |
| AccessKeyPolicy | string | yes | The network access restriction policy. A JSON-formatted string. For more information, see the AccessKeyPolicy structure description |

### Sets the account-level AccessKey network access control policy
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/set-access-key-policy-for-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AccessKeyPolicy | string | yes | The network access restriction policy. The value is a JSON-formatted string. For more information, see the AccessKeyPolicy structure… |

### Configures the default domain name for an Alibaba Cloud account
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/set-default-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| DefaultDomainName | string | yes | The default domain name. The default domain name is in the format of ` .onaliyun.com`. ` ` indicates the account alias. By default, the… |

### Set the password policy for Resource Access Management (RAM) users
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/set-password-policy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| MinimumPasswordLength | integer | no | Minimum password length. Valid values: 8 to 32. Default value: 8 |
| RequireLowercaseCharacters | string | no | Specifies whether passwords must contain lowercase letters. true false (default) |
| RequireUppercaseCharacters | string | no | Specifies whether passwords must contain uppercase letters. true false (default) |
| RequireNumbers | string | no | Specifies whether passwords must contain numbers. true false (default) |
| RequireSymbols | string | no | Specifies whether passwords must contain special characters. true false (default) |
| HardExpire | string | no | Specifies whether logon is blocked after a password expires. true: After a password expires, the RAM user cannot log on to the console. An… |
| MaxLoginAttemps | integer | no | Maximum number of failed password attempts. After the specified number of consecutive incorrect password attempts, the account is locked… |
| PasswordReusePrevention | integer | no | Prevents reuse of previous passwords. Valid values: 0 to 24. This value specifies how many previous passwords are blocked from reuse.… |
| MaxPasswordAge | integer | no | Password validity period. Valid values: 0 to 1095. Unit: days. Default value: 0, which means passwords never expire |
| MinimumPasswordDifferentCharacter | integer | no | Minimum number of unique characters in a password. Valid values: 0 to 8. Default value: 0, which imposes no restriction |
| PasswordNotContainUserName | string | no | Specifies whether passwords must not contain the user name. true false (default) |
| InitialPasswordAge | integer | no | Validity period for initial passwords. Initial passwords apply to newly created RAM users or users whose console logon settings are… |
| InterceptRiskPasswordOnApi | string | no | Specifies whether threat passwords are blocked when set using APIs. Default value: false true false (default) |

### Configure the global security preferences for a RAM user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/set-security-preference` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| EnableSaveMFATicket | string | no | Specifies whether a RAM user who logs on with multi-factor authentication (MFA) can skip MFA for the next seven days. Valid values: true:… |
| AllowUserToChangePassword | string | no | Specifies whether RAM users can change their own passwords. Valid values: true (default): Allowed. false: Not allowed |
| AllowUserToManageAccessKeys | string | no | Specifies whether RAM users can manage their own AccessKeys. Valid values: true: Allowed. false (default): Not allowed |
| AllowUserToManageMFADevices | string | no | Specifies whether RAM users can manage their own MFA devices. Valid values: true (default): Allowed. false: Not allowed |
| LoginSessionDuration | integer | no | The session duration of a RAM user who logs on to the console. Unit: hours. Valid values: 1 to 24. Default value: 6 |
| LoginNetworkMasks | string | no | The IP address mask that is used to log on to the console. This mask applies to password-based logons and single sign-on (SSO) logons, but… |
| VerificationTypes | string | no | The MFA methods (JSON-encoded) |
| AllowUserToManagePersonalDingTalk | string | no | Specifies whether RAM users can link or unlink their personal DingTalk accounts. Valid values: true (default): Allowed. false: Not allowed |
| OperationForRiskLogin | string | no | This parameter is deprecated |
| MFAOperationForLogin | string | no | Specifies the MFA policy for user logon. This parameter replaces `EnforceMFAForLogin`. We recommend that you use this parameter.… |
| MaxIdleDaysForAccessKeys | integer | no | The maximum idle period of the AccessKey pairs of RAM users. An AccessKey pair that is not used for the specified period of time is… |
| MaxIdleDaysForUsers | integer | no | The maximum idle period of RAM users. If a RAM user who can log on to the console does not log on to the console for the specified period… |
| AllowUserToLoginWithPasskey | string | no | Specifies whether RAM users can use passkeys to log on to the console. Valid values: true (default): Allowed. false: Not allowed |
| AllowUserToManageServiceCredentials | string | no | Specifies whether RAM users can manage their own API keys. Valid values: true: Allowed. false: Not allowed |

### Configures information about user-based single sign-on (SSO)
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/set-user-sso-settings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| MetadataDocument | string | no | The metadata file, which is Base64-encoded. The file is provided by an identity provider (IdP) that supports Security Assertion Markup… |
| SsoEnabled | string | no | Specifies whether to enable SSO for the RAM user. Valid values: true false (default) |
| AuxiliaryDomain | string | no | The auxiliary domain name |
| SsoLoginWithDomain | string | no | Specifies whether the SAML SSO requires a domain name in the ` ` element of the SAML response. If yes, the username specified by the IdP… |
| AuthnSignAlgo | string | no | The supported signature algorithm. Valid values: rsa-sha256 rsa-sha1 (default) |

### Binds a mobile phone or email to a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/set-verification-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the RAM user |
| VerifyType | string | no | The multi-factor authentication (MFA) method. Valid values: sms: mobile phone. email: email |
| MobilePhone | string | no | The mobile phone number. If you set `VerifyType` to `sms`, you must specify this parameter |
| Email | string | no | The email address. If you set `VerifyType` to `email`, you must specify this parameter |

### Adds tags to resources
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceType | string | no | The type of the resource. Valid value: user: a Resource Access Management (RAM) user |
| ResourceId | string | no | The ID of resource N. Valid values of N: 1 to 50. If the ResourceType parameter is set to user, the resource ID is the ID of the RAM user.… |
| ResourcePrincipalName | string | no | The name of resource N. Valid values of N: 1 to 50. If the ResourceType parameter is set to user, the resource name is the name of the RAM… |
| Tag | string | no | The key of tag N. Valid values of N: 1 to 20. You cannot specify empty strings as tag keys. The tag key can be up to 128 characters in… |

### Unbinds a multi-factor authentication (MFA) device from a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/unbind-mfadevice` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | yes | The logon name of the RAM user |

### Unbinds a mobile phone or email from a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/unbind-verification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the RAM user |
| VerifyType | string | no | The multi-factor authentication (MFA) method. Valid values: sms: mobile phone. email: email |
| MobilePhone | string | no | The mobile phone number. If you set `VerifyType` to `sms`, you must specify this parameter |
| Email | string | no | The email address. If you set `VerifyType` to `email`, you must specify this parameter |

### Removes tags from a resource
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ResourceType | string | no | The type of the resource. Valid value: user: a RAM user |
| All | string | no | Specifies whether to remove all tags from the resource. Valid values: true: remove all tags from the resources. false (default): does not… |
| ResourcePrincipalName | string | no | The names of resources. Valid values of N: 1 to 50. If the ResourceType parameter is set to user, the resource name is the name of the RAM… |
| ResourceId | string | no | The IDs of resources. Valid values of N: 1 to 50. If the ResourceType parameter is set to user, the resource ID is the ID of the RAM user.… |
| TagKey | string | no | The tag keys of resources. Valid values of N: 1 to 20. N must be consecutive (JSON-encoded) |

### Modifies the status of an AccessKey pair for an Alibaba Cloud account or a Resource Access Management (RAM)…
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/update-access-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the RAM user. If this parameter is empty, the status of the AccessKey pair for the current user is modified |
| UserAccessKeyId | string | yes | The AccessKey ID of the AccessKey pair for which you want to modify the status |
| Status | string | yes | The status of the AccessKey pair. Valid values: Active Inactive |

### Modifies the configuration of a specified application
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/update-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| AppId | string | yes | The application ID |
| NewDisplayName | string | no | The display name |
| NewRedirectUris | string | no | The callback URLs. Separate multiple URLs with semicolons (;) |
| NewPredefinedScopes | string | no | The permission scope of the application. For more information about the valid values and descriptions of application permission scopes,… |
| NewRequiredScopes | string | no | The required permission scopes of the application. You can set one or more scopes in `RequiredScopes` as required. After a scope is set as… |
| NewSecretRequired | string | no | Specifies whether an application secret is required. Valid values: true false For WebApp and ServerApp applications, this value is… |
| NewAccessTokenValidity | integer | no | The validity period of the access token. Valid values: 900 to 10800. Unit: seconds |
| NewRefreshTokenValidity | integer | no | The validity period of the refresh token. Valid values: 7200 to 31536000. Unit: seconds |
| NewIsMultiTenant | string | no | Specifies whether the application is allowed to be installed by other accounts. Valid values: true: Allowed. false: Not allowed |

### Modifies the basic information of a specified user group
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/update-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| NewComments | string | no | The new comments. Maximum length: 128 characters |
| NewDisplayName | string | no | The new display name of the user group. Maximum length: 24 characters |
| NewGroupName | string | no | The new name of the user group. Maximum length: 64 characters. The name can contain letters, digits, periods (.), underscores (_), and… |
| GroupName | string | no | The name of the user group |

### Modifies the console logon information of a specified Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/update-login-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | yes | The logon name of the Resource Access Management (RAM) user |
| Password | string | no | The new console logon password of the Resource Access Management (RAM) user. The password must meet the password strength requirements |
| PasswordResetRequired | string | no | Specifies whether the Resource Access Management (RAM) user is required to reset the password at the next logon. Valid values: true false |
| MFABindRequired | string | no | Specifies whether the Resource Access Management (RAM) user is required to enable multi-factor authentication (MFA). Valid values: true:… |
| Status | string | no | Enables or disables console password logon. Valid values: Active: enables console password logon. Inactive: disables console password logon |

### Modifies the description and client IDs of an OpenID Connect (OIDC) identity provider (IdP)
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/update-oidcprovider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| OIDCProviderName | string | no | The name of the OIDC IdP |
| ClientIds | string | no | The ID of the client. If you want to specify multiple client IDs, separate the client IDs with commas (,). A client ID can contain… |
| NewDescription | string | no | The description of the OIDC IdP. The description can be up to 256 characters in length |
| IssuanceLimitTime | integer | no | The earliest time when an external IdP can issue an ID token. If the value of the iat field in the ID token is later than the current… |

### Updates a passkey
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/update-passkey` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the Resource Access Management (RAM) user |
| PasskeyId | string | no | The ID of the passkey |
| PasskeyName | string | no | The name of the passkey |

### Updates the information about a specified identity provider for role-based single sign-on (SSO)
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/update-samlprovider` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| SAMLProviderName | string | yes | The name of the identity provider to modify |
| NewDescription | string | no | The new description. Specify at least one of the `NewDescription` and `NewEncodedSAMLMetadataDocument` parameters |
| NewEncodedSAMLMetadataDocument | string | no | The new metadata file. Specify at least one of the `NewDescription` and `NewEncodedSAMLMetadataDocument` parameters |
| AuthnSignAlgo | string | no | The signature algorithm supported by the Alibaba Cloud service provider (SP). Valid values: rsa-sha256 rsa-sha1 |

### Updates the status or name of a service credential for a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/update-service-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| ServiceCredentialId | string | yes | The ID of the service credential |
| UserPrincipalName | string | no | The logon name of the Resource Access Management (RAM) user. If not specified, the service credential of the current invoke identity is… |
| Status | string | no | The status of the service credential. Valid values: Active, Inactive. You must specify at least one of Status and ServiceCredentialName |
| ServiceCredentialName | string | no | The name of the service credential. The name must be 1 to 128 characters in length and can contain letters, digits, periods (.), hyphens… |

### Invokes UpdateUser to modify the information of a Resource Access Management (RAM) user
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/update-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| UserPrincipalName | string | no | The logon name of the specified Resource Access Management (RAM) user. You must specify either the `UserPrincipalName` or `UserId`… |
| UserId | string | no | The ID of the specified Resource Access Management (RAM) user. You must specify either the `UserPrincipalName` or `UserId` parameter, but… |
| NewUserPrincipalName | string | no | The new logon name of the Resource Access Management (RAM) user. The format is ` @ .onaliyun.com`, where ` ` is the RAM username and `… |
| NewDisplayName | string | no | The new display name of the Resource Access Management (RAM) user. The name must be 1 to 24 characters in length |
| NewMobilePhone | string | no | The new mobile phone number of the Resource Access Management (RAM) user. Format: area code-phone number. This parameter is applicable… |
| NewEmail | string | no | The new email address of the Resource Access Management (RAM) user. This parameter is applicable only to China site (aliyun.com) |
| NewComments | string | no | The new comments. The comments must be 1 to 128 characters in length |

### version
`POST https://www.apizie.tech/v1/cloud:aliyun-ims/version` (byok)

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-ims/add-client-id-to-oidcprovider" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud RAM Identity Management Service API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-ims/add-client-id-to-oidcprovider with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud RAM Identity Management Service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud RAM Identity Management Service itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud RAM Identity Management Service API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-ims.

### What is the status of the Alibaba Cloud RAM Identity Management Service API?
Needs your own provider key (bring your own key)