GetConditionalAccessPolicy - Identity as a Service - Alibaba Cloud Documentation Center

Retrieves a conditional access policy.

Operation description

This operation retrieves a conditional access policy.

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 support 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

eiam:GetConditionalAccessPolicy

get

*ConditionalAccessPolicy

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/conditionalaccesspolicy/{#ConditionalAccessPolicyId}

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
ConditionalAccessPolicyId	string	Yes	The ID of the conditional access policy.	cap_11111

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
ConditionalAccessPolicy	object	The details of the conditional access policy.
InstanceId	string	The instance ID.	idaas_qnx6fbrinlecptl5hld23lfkvy
ConditionalAccessPolicyId	string	The ID of the conditional access policy.	cp_xxxxx
ConditionalAccessPolicyName	string	The name of the conditional access policy.	My Policy
Description	string	The description of the conditional access policy.	ga access port for ecs: internal-cn-hangzhou-docker-builder-2(i-bp19g1pheaailkk1xvr6)
ConditionalAccessPolicyType	string	The type of the conditional access policy.	arn:alibaba:idaas:authn:access:policy:system
Status	string	The status of the conditional access policy.	enabled
DecisionType	string	The execution type of the conditional access policy.	enforcement
EvaluateAt	string	The policy enforcement point of the conditional access policy.	arn:alibaba:idaas:authn:access:rule:eval_at:after_step1
DecisionConfig	object	The action of the conditional access policy.
Effect	string	The decision action of the conditional access policy.	allow
MfaType	string	The multi-factor authentication (MFA) type of the conditional access policy.	directly_access
MfaAuthenticationIntervalSeconds	integer	The interval in seconds at which re-authentication is required for the conditional access policy.	300
MfaAuthenticationMethods	array	The MFA methods that are allowed by the conditional access policy.
	string	The MFA methods that are allowed by the conditional access policy. Valid values: ia_otp_sms: text message verification code. ia_otp_email: email verification code. ia_totp: OTP dynamic password. ia_webauthn: WebAuthn.	ia_otp_sms
ActiveSessionReuseStatus	string	Indicates whether session reuse is enabled.	enabled
ConditionsConfig	object	The content of the conditional access policy.
Applications	object	The applications to which the conditional access policy applies.
IncludeApplications	array	The selected applications.
	string	The application ID.	app_xxxx
ExcludeApplications	array	The excluded applications.
	string	The application ID.	app_xxxx
Users	object	The users to whom the conditional access policy applies.
IncludeUsers	array	The selected users.
	string	The user ID.	user_xxxxx
ExcludeUsers	array	The excluded users.
	string	The user ID.	user_xxxxx
IncludeGroups	array	The selected user groups.
	string	The user group ID.	group_xxxxx
ExcludeGroups	array	The excluded user groups.
	string	The user group ID.	group_xxxxx
IncludeOrganizationalUnits	array	The selected organizations.
	string	The organization ID.	ou_xxxxx
ExcludeOrganizationalUnits	array	The excluded organizations.
	string	The organization ID.	ou_xxxxx
NetworkZones	object	The network zones of the conditional access policy.
IncludeNetworkZones	array	The selected network zones.
	string	The network zone ID.	network_xxxxx
ExcludeNetworkZones	array	The excluded network zones.
	string	The network zone ID.	network_xxxxx
Priority	integer	The priority.	5
CreateTime	integer	The time when the policy was created.	1741857554000
LastUpdatedTime	integer	The time when the policy was last updated.	1741857554000

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "ConditionalAccessPolicy": {
    "InstanceId": "idaas_qnx6fbrinlecptl5hld23lfkvy",
    "ConditionalAccessPolicyId": "cp_xxxxx",
    "ConditionalAccessPolicyName": "My Policy",
    "Description": "ga access port for ecs: internal-cn-hangzhou-docker-builder-2(i-bp19g1pheaailkk1xvr6)",
    "ConditionalAccessPolicyType": "arn:alibaba:idaas:authn:access:policy:system",
    "Status": "enabled",
    "DecisionType": "enforcement",
    "EvaluateAt": "arn:alibaba:idaas:authn:access:rule:eval_at:after_step1",
    "DecisionConfig": {
      "Effect": "allow",
      "MfaType": "directly_access",
      "MfaAuthenticationIntervalSeconds": 300,
      "MfaAuthenticationMethods": [
        "ia_otp_sms"
      ],
      "ActiveSessionReuseStatus": "enabled"
    },
    "ConditionsConfig": {
      "Applications": {
        "IncludeApplications": [
          "app_xxxx"
        ],
        "ExcludeApplications": [
          "app_xxxx\n"
        ]
      },
      "Users": {
        "IncludeUsers": [
          "user_xxxxx"
        ],
        "ExcludeUsers": [
          "user_xxxxx"
        ],
        "IncludeGroups": [
          "group_xxxxx"
        ],
        "ExcludeGroups": [
          "group_xxxxx"
        ],
        "IncludeOrganizationalUnits": [
          "ou_xxxxx"
        ],
        "ExcludeOrganizationalUnits": [
          "ou_xxxxx"
        ]
      },
      "NetworkZones": {
        "IncludeNetworkZones": [
          "network_xxxxx"
        ],
        "ExcludeNetworkZones": [
          "network_xxxxx"
        ]
      }
    },
    "Priority": 5,
    "CreateTime": 1741857554000,
    "LastUpdatedTime": 1741857554000
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.