latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Role

Get temporary permission grants

Retrieve the temporary permission grants that match the given filters.

Permissions

This endpoint may be impacted by the following permissions:

  • Only temporary permission grants that the authenticated user has Role:GetTemporaryPermissionGrant permission for will be returned.
get/v1/{organization}/role/temporary_permission_grants/

Path parameters

organizationstring required

Query parameters

idstring[]

The IDs of the temporary permission grants to retrieve.

The IDs of the temporary permission grants to retrieve.

user_idstring[]

The user IDs of the temporary permission grants to retrieve.

The user IDs of the temporary permission grants to retrieve.

permission_grant_namestring nullable

The permission name of the grants.

The permission name of the grants.

is_expiredboolean nullable

Whether to only return expired or unexpired temporary permission grants.

Whether to only return expired or unexpired temporary permission grants.

limitinteger

The maximum number of temporary permission grants to return.

The maximum number of temporary permission grants to return.

continuation_tokeninteger

The continuation token to use to retrieve the next set of temporary permission grants.

The continuation token to use to retrieve the next set of temporary permission grants.

creatorstring[]

The creators of the temporary permission grants.

The creators of the temporary permission grants.

tagstring[]

The tags of the temporary permission grants. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.

The tags of the temporary permission grants. Must be specified using the syntax key:value, which means to match all sets with the given key and value pair among its tags. If value is *, it means the value does not matter. If value is empty, it matches against when the value is None.

sort_bystring[]

The fields to sort the sets by. Supported fields are user_id, expires_at, and permission_grant.permission_name. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

The fields to sort the sets by. Supported fields are user_id, expires_at, and permission_grant.permission_name. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Succeeded.

has_moreboolean required

Whether there are more temporary permission grants to retrieve.

continuation_tokeninteger nullable required

The continuation token to use to retrieve the next set of temporary permission grants.