Skip to content

ListPermissionsRequest

Source code in docs_src/capo_grafana/types/list_permissions_request.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class ListPermissionsRequest(TypedDict, closed=True):
    max_results: NotRequired["int"]
    """<p>The maximum number of results to include in the response.</p>"""
    next_token: NotRequired["capo_grafana.types.pagination_token.PaginationToken"]
    """<p>The token to use when requesting the next set of results. You received this token from a previous <code>ListPermissions</code> operation.</p>"""
    user_type: NotRequired["capo_grafana.types.user_type.UserType"]
    """<p>(Optional) If you specify <code>SSO_USER</code>, then only the permissions of IAM Identity Center users are returned. If you specify <code>SSO_GROUP</code>, only the permissions of IAM Identity Center groups are returned.</p>"""
    user_id: NotRequired["capo_grafana.types.sso_id.SsoId"]
    """<p>(Optional) Limits the results to only the user that matches this ID.</p>"""
    group_id: NotRequired["capo_grafana.types.sso_id.SsoId"]
    """<p>(Optional) Limits the results to only the group that matches this ID.</p>"""
    workspace_id: "capo_grafana.types.workspace_id.WorkspaceId"
    """<p>The ID of the workspace to list permissions for. This parameter is required.</p>"""

group_id instance-attribute 

group_id: NotRequired[SsoId]

(Optional) Limits the results to only the group that matches this ID.

max_results instance-attribute 

max_results: NotRequired[int]

The maximum number of results to include in the response.

next_token instance-attribute 

next_token: NotRequired[PaginationToken]

The token to use when requesting the next set of results. You received this token from a previous ListPermissions operation.

user_id instance-attribute 

user_id: NotRequired[SsoId]

(Optional) Limits the results to only the user that matches this ID.

user_type instance-attribute 

user_type: NotRequired[UserType]

(Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned. If you specify SSO_GROUP, only the permissions of IAM Identity Center groups are returned.

workspace_id instance-attribute 

workspace_id: WorkspaceId

The ID of the workspace to list permissions for. This parameter is required.