Permissions
Manage fine-grained permissions
Use the permission client to define fine-grained permissions that roles can grant.
Model permissions for resources in your app, then attach them to roles.
CreatePermission
Section titled “CreatePermission”#asyncCreatePermission
CreatePermission creates a new permission
Request context
Permission creation payload.
The created resource.
GetPermission
Section titled “GetPermission”#asyncGetPermission
GetPermission retrieves a permission by name
Request context
Permission name.
The response payload for this operation.
ListPermissions
Section titled “ListPermissions”#asyncListPermissions
ListPermissions lists all permissions with optional pagination.
Request context
Page token.
Page size.
Paginated results.
UpdatePermission
Section titled “UpdatePermission”#asyncUpdatePermission
UpdatePermission updates an existing permission by name
Request context
Permission name.
Permission update payload.
The updated resource.
DeletePermission
Section titled “DeletePermission”#asyncDeletePermission
DeletePermission deletes a permission by name
Request context
Permission name.
error
ListRolePermissions
Section titled “ListRolePermissions”#asyncListRolePermissions
ListRolePermissions lists all permissions associated with a role
Request context
Role name.
Paginated results.
AddPermissionsToRole
Section titled “AddPermissionsToRole”#asyncAddPermissionsToRole
AddPermissionsToRole adds permissions to a role
Request context
Role name.
Permission names.
The created resource.
RemovePermissionFromRole
Section titled “RemovePermissionFromRole”#asyncRemovePermissionFromRole
RemovePermissionFromRole removes a permission from a role
Request context
Role name.
Permission name.
error
ListEffectiveRolePermissions
Section titled “ListEffectiveRolePermissions”#asyncListEffectiveRolePermissions
ListEffectiveRolePermissions lists all effective permissions for a role (including inherited permissions)
Request context
Role name.
Paginated results.