Skip to content
OTA-Pulse Docs

List active shell role grants for a user

GET
/api/users/{user_id}/roles
 
curl --request GET \
  --url 'https://example.com/api/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/roles?organization_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'Authorization: Bearer <token>'

Return all active (revoked_at IS NULL) shell role grants for user_id in org.

Requires OWNER or ADMIN tenancy role.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
user_id
required
User Id
string format: uuid

Query Parameters

Section titled “ Query Parameters ”
organization_id
required
Organization Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
RoleListResponse

Paginated list of active role grants.

object
items
required
Items
Array<object>
object
key
additional properties
any
total
required
Total
integer
Example generated 
{
  "items": [
    {}
  ],
  "total": 1
}

422

Section titled “ 422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated 
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}