Skip to content
Authrim

Return a protected customer profile.

GET
/api/protected/customer-profiles/{userId}
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/protected/customer-profiles/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
userId
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
profile
required
object
sub
required
string
tenant_id
required
string
name
string | null
given_name
string | null
family_name
string | null
email
string | null format: email
email_verified
required
boolean
phone_number
string | null
phone_number_verified
required
boolean
address
object | null
updated_at
required
integer
key
additional properties
correlation_id
required
string
redaction_level
required
string
Allowed values: summary masked raw
requires_online_check
required
boolean
fail_closed
required
boolean
Example 
{
  "profile": {
    "sub": "user_123",
    "tenant_id": "tenant_123",
    "name": "Example User",
    "email": "[email protected]",
    "email_verified": true,
    "phone_number_verified": false,
    "updated_at": 1770000000000
  },
  "correlation_id": "corr_123",
  "redaction_level": "masked",
  "requires_online_check": false,
  "fail_closed": true
}

401

Section titled “401 ”

Error response.

Media type application/json
object
key
additional properties
Example generated
{
  "additionalProperty": "example"
}