Skip to main content

Update My Profile​

Change the profile information of the authenticated user. This includes information like given name, family name, language, etc.

Request Body required
    firstName string required

    Possible values: non-empty and <= 200 characters

    lastName string required

    Possible values: non-empty and <= 200 characters

    nickName string

    Possible values: non-empty and <= 200 characters

    displayName string required

    Possible values: non-empty and <= 200 characters

    preferredLanguage string

    Possible values: <= 10 characters

    gender string

    Possible values: [GENDER_UNSPECIFIED, GENDER_FEMALE, GENDER_MALE, GENDER_DIVERSE]

    Default value: GENDER_UNSPECIFIED

Responses

A successful response.

Schema
    details object
    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to
PUT /users/me/profile

Authorization

name: OAuth2type: oauth2scopes: openidflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN/auth/v1
Bearer Token
Content-Type
Body required
{

  "firstName": "Minnie",

  "lastName": "Mouse",

  "nickName": "Minnie",

  "displayName": "Minnie Mouse",

  "preferredLanguage": "en",

  "gender": "GENDER_UNSPECIFIED"

}
Accept
curl / cURL
curl -L -X PUT 'https://$CUSTOM-DOMAIN/auth/v1/users/me/profile' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "firstName": "Minnie",
  "lastName": "Mouse",
  "nickName": "Minnie",
  "displayName": "Minnie Mouse",
  "preferredLanguage": "en",
  "gender": "GENDER_UNSPECIFIED"
}'