DescribeInstanceAccessControlAttributeConfiguration - AWS Single Sign-On

DescribeInstanceAccessControlAttributeConfiguration

Returns the list of AWS SSO identity store attributes that have been configured to work with attributes-based access control (ABAC) for the specified AWS SSO instance. This will not return attributes configured and sent by an external identity provider. For more information about ABAC, see Attribute-Based Access Control in the AWS SSO User Guide.

Request Syntax

{ "InstanceArn": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

InstanceArn

The ARN of the SSO instance under which the operation will be executed.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 1224.

Pattern: arn:aws:sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}

Required: Yes

Response Syntax

{ "InstanceAccessControlAttributeConfiguration": { "AccessControlAttributes": [ { "Key": "string", "Value": { "Source": [ "string" ] } } ] }, "Status": "string", "StatusReason": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

InstanceAccessControlAttributeConfiguration

Gets the list of AWS SSO identity store attributes that have been added to your ABAC configuration.

Type: InstanceAccessControlAttributeConfiguration object

Status

The status of the attribute configuration process.

Type: String

Valid Values: ENABLED | CREATION_IN_PROGRESS | CREATION_FAILED

StatusReason

Provides more details about the current status of the specified attribute.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception, or failure with an internal server.

HTTP Status Code: 400

ResourceNotFoundException

Indicates that a requested resource is not found.

HTTP Status Code: 400

ThrottlingException

Indicates that the principal has crossed the throttling limits of the API operations.

HTTP Status Code: 400

ValidationException

The request failed because it contains a syntax error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: