Use GetUserProvisioningConfiguration to query RAM user provisioning configurations - CloudSSO - Alibaba Cloud - CloudSSO

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cloudsso:GetUserProvisioningConfiguration

get

*Directory

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

None

Request parameters

Parameter	Type	Required	Description	Example
DirectoryId	string	Yes	The ID of the directory.	d-00fc2p61****

Response elements

Element	Type	Description	Example
	object	The returned results.
RequestId	string	The request ID.	66898413-EB80-556D-9429-06FE3548F672
UserProvisioningConfiguration	object	The global configuration of RAM user provisioning.
SessionDuration	integer	The duration of the logon session. Unit: hours. Valid values: 1 to 24. Default value: 6.	10
CreateTime	string	The time when the global configuration was created, in ISO 8601 format in the UTC time zone.	2022-11-28T03:55:42Z
DirectoryId	string	The ID of the directory.	d-00fc2p61****
DefaultLandingPage	string	The default URL for a CloudSSO user who logs on to the Alibaba Cloud Management Console. Default value: https://home.console.alibabacloud.com.	https://home.console.alibabacloud.com
UpdateTime	string	The time when the global configuration was last modified, in ISO 8601 format in the UTC time zone.	2022-11-28T03:55:42Z

Examples

Success response

JSON format

{
  "RequestId": "66898413-EB80-556D-9429-06FE3548F672",
  "UserProvisioningConfiguration": {
    "SessionDuration": 10,
    "CreateTime": "2022-11-28T03:55:42Z",
    "DirectoryId": "d-00fc2p61****",
    "DefaultLandingPage": "https://home.console.alibabacloud.com",
    "UpdateTime": "2022-11-28T03:55:42Z"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.