Get current user's notification preferences

GET

/v1/users/me/notification-preferences

curl --request GET \
  --url https://example.com/v1/users/me/notification-preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Tenant-ID: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

Authorizations

• BearerAuth

Parameters

Header Parameters

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.

Responses

200

OK

Media type application/json

object

preferences

required

Array<object>

object

event_type

required

string

Allowed values: request.pending request.approved request.denied request.expired request.break_glass grant.active grant.expiring_soon grant.expired grant.revoked

channel

required

string

Allowed values: email slack in_app

enabled

required

boolean

Example

{
  "preferences": [
    {
      "event_type": "request.pending",
      "channel": "email"
    }
  ]
}

401

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"
  ]
}