Skip to content

List profiles from active grants for the authenticated user

GET
/v1/registry/profiles
curl --request GET \
--url 'https://example.com/v1/registry/profiles?limit=50&status=active' \
--header 'Authorization: Bearer <token>' \
--header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'
X-Tenant-ID
required
string format: uuid

Tenant identifier. Must match the tenant associated with the credential. Returns 403 tenant_mismatch if the credential and header belong to different tenants.

page_token
string

Pagination cursor from a previous response.

limit
integer
default: 50 <= 250

Maximum number of profiles to return.

status
string
default: active
Allowed values: active available all

Filter profiles by status.

  • active: only currently active grants (default)
  • available: only requestable entitlements the user is eligible for
  • all: both active grants and requestable entitlements

Profiles list

Media type application/json
object
profiles
required
Array<object>
object
name
required
string
attributes
required
Array<object>
object
key
required
string
value
required
string
status

Whether this profile represents an active grant or a requestable entitlement.

string
Allowed values: active available
approval_mode

For available profiles, whether access would be auto-approved or require manual approval.

string
Allowed values: auto require
next_page_token
required
string
Example
{
"profiles": [
{
"status": "active",
"approval_mode": "auto"
}
]
}

Unauthenticated

Media type application/json
object
code
required

Machine-readable error code (e.g. “not_found”, “tenant_mismatch”).

string
message
required

Human-readable description of the error.

string
details

Optional additional context about the error.

object
key
additional properties
any
notices

Policy notices from determining Cedar rules, if applicable.

Array<string>
Example generated
{
"code": "example",
"message": "example",
"details": {},
"notices": [
"example"
]
}