Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

List Group Access

GET
/iam/v1/groups/{group}/access
curl --request GET \
--url https://example.com/iam/v1/groups/example/access

Returns every principal with effective access at a group, each role tagged direct or inherited. Use - for the group to list the direct grants across every group the caller administers.

group
required
string

The unique identifier of the group, or - for every group the caller administers.

page_size
integer format: int32

The maximum number of entries to return. The service may return fewer than this value. If unspecified, at most 20 entries will be returned. The maximum value is 100; values above 100 will be coerced to 100.

page_token
string

This rolled-up listing pages by offset (skip) only and never issues page tokens; a request supplying a page token is rejected as invalid.

filter
string

AIP-160 filter expression. Filterable fields: create_time, policy_id, principal_id, principal_type, role_id, scope_id, scope_type, update_time.

order_by
string

AIP-132 order_by expression. Sortable fields: create_time, principal_type, update_time.

skip
string

AIP-158 offset mode: number of entries to skip from the start of the rolled-up set. This listing pages by offset only - page_token is not supported, and a request supplying both is an invalid request. Default 0 (no skip).

OK

Media type application/json

ListGroupAccessResponse

Response message for ListGroupAccess.

object
access

One row per principal and group with access there.

Array<object>

One principal’s effective access at a scope: the principal plus every role they hold there, each tagged direct/inherited.

object
principal

The principal that has access.

object
id

The unique identifier of the principal.

stringOutput only
display_name

Polymorphic human-readable label: a Person’s “name surname” or a service account’s service email.

stringOutput only
status

The lifecycle status of the principal.

string format: enum Output only
Allowed values: PRINCIPAL_STATUS_UNSPECIFIED PRINCIPAL_STATUS_INVITED PRINCIPAL_STATUS_ACTIVE PRINCIPAL_STATUS_DEACTIVATED
type

The discriminated kind of the principal.

string format: enum Output only
Allowed values: PRINCIPAL_TYPE_UNSPECIFIED PRINCIPAL_TYPE_USER PRINCIPAL_TYPE_SERVICE_ACCOUNT
last_seen_time

Best-effort last-authentication instant; absent until the principal first authenticates.

string format: date-time Output only
create_time

The timestamp when the principal was created.

string format: date-time Output only
update_time

The timestamp when the principal was last updated.

string format: date-time Output only
roles

Every effective role the principal holds at the requested scope.

Array<object>Output only

A single effective role a principal holds at a scope, tagged with its origin.

object
role_id

The unique identifier of the role.

stringOutput only
role_name

The handle of the role, e.g. “compute-editor”. Addresses the role by name.

stringOutput only
origin

Whether the role is direct or inherited.

string format: enum Output only
Allowed values: ROLE_ORIGIN_UNSPECIFIED ROLE_ORIGIN_DIRECT ROLE_ORIGIN_INHERITED
origin_scope_type

The scope type the role was inherited from; empty when origin is DIRECT.

string format: enum Output only
Allowed values: SCOPE_TYPE_UNSPECIFIED SCOPE_TYPE_WORKSPACE SCOPE_TYPE_GROUP SCOPE_TYPE_ORGANISATION SCOPE_TYPE_PLATFORM
origin_scope_id

The scope id the role was inherited from; empty when origin is DIRECT.

stringOutput only
role_display_name

A human-readable label for the role, e.g. “Compute Editor”. Never used to address it.

stringOutput only
scope_type

The kind of scope this row reports access at. A wildcard listing returns rows for many scopes, so each row names its own.

string format: enum Output only
Allowed values: SCOPE_TYPE_UNSPECIFIED SCOPE_TYPE_WORKSPACE SCOPE_TYPE_GROUP SCOPE_TYPE_ORGANISATION SCOPE_TYPE_PLATFORM
scope_id

The unique identifier of the scope this row reports access at. Empty for the platform.

stringOutput only
create_time

The earliest time that any of the roles in this row was granted. The create_time filter and sort key read this value. A row describes the grants that match the request’s filter, so a filter on create_time or update_time can move this value later.

string format: date-time Output only
update_time

The latest time that any of the roles in this row was changed. The update_time filter and sort key read this value, over the same grants as create_time.

string format: date-time Output only
next_page_token

Always empty - this rolled-up listing pages by offset only; continue with skip.

string
total_size

Exact count of entries matching the request’s filter and scope, independent of paging.

string
Example
{
"access": [
{
"principal": {
"status": "PRINCIPAL_STATUS_UNSPECIFIED",
"type": "PRINCIPAL_TYPE_UNSPECIFIED"
},
"roles": [
{
"origin": "ROLE_ORIGIN_UNSPECIFIED",
"origin_scope_type": "SCOPE_TYPE_UNSPECIFIED"
}
],
"scope_type": "SCOPE_TYPE_UNSPECIFIED"
}
]
}

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}