All Products
Search
Document Center

Identity as a Service:ListGroupsForAuthorizationRule

Last Updated:Jan 29, 2026

Lists the groups associated with an authorization rule.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The instance ID.

idaas_ue2jvisn35ea5lmthk267xxxxx

NextToken

string

No

The token that is used to start the next paged query.

  • If you do not specify this parameter, the query starts from the first page.

NTxxxxxexample

MaxResults

integer

No

The maximum number of entries to return on each page.

  • Default value: 20.

  • The value cannot exceed 100.

20

AuthorizationRuleId

string

Yes

The authorization rule ID.

arrule_01kf143ug06fg7m9f43u7vahxxxx

Filter

array<object>

No

The filter conditions.

object

No

The filter conditions.

Name

string

No

The name of the filter field. Valid values:

  • GroupId: The group ID.

GroupId

Value

array

No

The values of the filter field.

string

No

The value of the filter field.

group_d6sbsuumeta4h66ec3il7yxxxx

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

0441BD79-92F3-53AA-8657-F8CE4A2B912A

TotalCount

integer

The total number of entries returned.

100

NextToken

string

The token that is returned for the next page.

NTxxxexample

MaxResults

integer

The number of entries returned per page.

20

Groups

array<object>

The list of groups.

array<object>

The group data object.

InstanceId

string

The instance ID.

idaas_ue2jvisn35ea5lmthk267xxxxx

GroupId

string

The group ID.

group_d6sbsuumeta4h66ec3il7yxxxx

ValidityType

string

The type of the validity period of the relationship. Valid values:

  • permanent: permanent

  • time_bound: custom time range

permanent

ValidityPeriod

object

The time range of the validity period. This parameter takes effect only when ValidityType is set to time_bound.

StartTime

integer

The start time of the validity period. The value is a UNIX timestamp. Unit: milliseconds.

1704042061000

EndTime

integer

The end time of the validity period. The value is a UNIX timestamp. Unit: milliseconds.

1704042061000

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample",
  "MaxResults": 20,
  "Groups": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "GroupId": "group_d6sbsuumeta4h66ec3il7yxxxx",
      "ValidityType": "permanent",
      "ValidityPeriod": {
        "StartTime": 1704042061000,
        "EndTime": 1704042061000
      }
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.