DeleteAccessAssignment

Updated at:
Copy as MD

Calls DeleteAccessAssignment to remove an access assignment from an account in a resource directory.

Operation description

This API operation is an asynchronous operation. You can use the TaskId in the response parameters to invoke GetTask to query the task execute status.

This topic provides an example on how to remove the authorization on the account in a resource directory 114240524784****, where the CloudSSO user u-00q8wbq42wiltcrk**** uses the access configuration ac-00jhtfl8thteu6uj****.

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:DeleteAccessAssignment

delete

*AccessConfiguration

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/access-configuration/{#AccessConfigurationId}

User

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

Group

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

*Account

acs:resourcemanager::{#accountId}:account/{#AccountId}

None None

Request parameters

Parameter

Type

Required

Description

Example

DirectoryId

string

Yes

The directory ID.

d-00fc2p61****

AccessConfigurationId

string

Yes

The access configuration ID.

ac-00jhtfl8thteu6uj****

TargetType

string

Yes

The type of the task target. Valid values: RD-Account, which indicates that the task target type is an account in a resource directory.

RD-Account

TargetId

string

Yes

The ID of the task target.

114240524784****

PrincipalType

string

Yes

The type of the CloudSSO identity. Valid values:

  • User: a user.

  • Group: a group.

User

PrincipalId

string

Yes

The ID of the CloudSSO identity. The value depends on the PrincipalType:

  • If PrincipalType is set to User, PrincipalId is the ID of the CloudSSO user.

  • If PrincipalType is set to Group, PrincipalId is the ID of the CloudSSO group.

u-00q8wbq42wiltcrk****

DeprovisionStrategy

string

No

Specifies whether to remove the access configuration deployment when you remove the last authorization on an account in a resource directory that uses the access configuration. Valid values:

  • DeprovisionForLastAccessAssignmentOnAccount: Remove the access configuration deployment.

  • None (default): Do not remove the access configuration deployment.

None

Response elements

Element

Type

Description

Example

object

The response parameters.

Task

object

The task information.

Status

string

The task status. Valid values:

  • InProgress: The task is running.

  • Success: The task succeeded.

  • Failed: The task failed.

InProgress

TaskId

string

The task ID.

t-shfqw1u1edszvxw5****

PrincipalId

string

The ID of the CloudSSO identity.

u-00q8wbq42wiltcrk****

TargetPath

string

The path ID of the task target in the resource directory.

rd-3G****/r-Wm****/114240524784****

PrincipalName

string

The name of the CloudSSO identity.

Alice

TargetName

string

The name of the task target.

dev-test

TargetId

string

The ID of the task target.

114240524784****

AccessConfigurationName

string

The name of the access configuration.

ECS-Admin

TargetPathName

string

The path name of the task target in the resource directory.

rd-3G****/root/dev-test

TaskType

string

The type of the task. Valid values: DeleteAccessAssignment, which indicates a task to remove an access assignment from an account in a resource directory.

DeleteAccessAssignment

TargetType

string

The type of the task target. Valid values: RD-Account, which indicates that the task target type is an account in a resource directory.

RD-Account

AccessConfigurationId

string

The access configuration ID.

ac-00jhtfl8thteu6uj****

PrincipalType

string

The type of the CloudSSO identity. Valid values:

  • User: a user.

  • Group: a group.

User

OriginTargetId

string

114240524784****

RequestId

string

The request ID.

5C9D0CF4-5CE8-5CE6-932A-826EF4ADD007

Examples

Success response

JSON format

{
  "Task": {
    "Status": "InProgress",
    "TaskId": "t-shfqw1u1edszvxw5****",
    "PrincipalId": "u-00q8wbq42wiltcrk****",
    "TargetPath": "rd-3G****/r-Wm****/114240524784****",
    "PrincipalName": "Alice",
    "TargetName": "dev-test",
    "TargetId": "114240524784****",
    "AccessConfigurationName": "ECS-Admin",
    "TargetPathName": "rd-3G****/root/dev-test",
    "TaskType": "DeleteAccessAssignment",
    "TargetType": "RD-Account",
    "AccessConfigurationId": "ac-00jhtfl8thteu6uj****",
    "PrincipalType": "User",
    "OriginTargetId": "114240524784****"
  },
  "RequestId": "5C9D0CF4-5CE8-5CE6-932A-826EF4ADD007"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.