Skip to content
Authrim

Read the current Account Page profile.

GET
/api/account/profile
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/account/profile \
  --cookie authrim_session=<authrim_session>

Returns the authenticated Account Page user’s minimal profile and current Authrim browser session metadata. Authentication uses the authrim_session cookie.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Account Page profile response.

Media type application/json
object
profile
required
object
user_id
required
string
registration_state
required
string
Allowed values: guest registered
email
string | null format: email
email_verified
required
boolean
name
string | null
given_name
string | null
family_name
string | null
locale
string | null
picture
string | null
session
required
object
id
required
string
created_at
required
integer
expires_at
required
integer
auth_time
required
integer
acr
string
amr
Array<string>
Example 
{
  "profile": {
    "registration_state": "guest"
  }
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
error_code

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
error_code

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}