Update current Account Page profile.

PATCH

/api/account/profile

Code sample: Shell / cURL

curl --request PATCH \
  --url https://auth.example.com/api/account/profile \
  --header 'Content-Type: application/json' \
  --cookie authrim_session=<authrim_session> \
  --data '{ "name": "example" }'

Updates mutable profile fields for the authenticated Account Page user. The initial implementation supports name changes.

Authorizations

• accountSessionCookie

Request Body ^required

Media type application/json

object

name

required

string

<= 100 characters

Example ^generated

{
  "name": "example"
}

Responses

200

Account Page profile response.

Media type application/json

object

profile

required

object

user_id

required

string

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 ^generated

{
  "profile": {
    "user_id": "example",
    "email": "[email protected]",
    "email_verified": true,
    "name": "example",
    "given_name": "example",
    "family_name": "example",
    "locale": "example",
    "picture": "example"
  },
  "session": {
    "id": "example",
    "created_at": 1,
    "expires_at": 1,
    "auth_time": 1,
    "acr": "example",
    "amr": [
      "example"
    ]
  }
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}