Update profile

PATCH /api/profile
OAuth2

Update profile for the user, only the fields that are passed in will be updated.

application/json

Body Required

  • name string | null

    The new name for the user.

  • avatar string(url) | null

    The new avatar for the user, must be a URL.

  • username string(regex)

    The new username for the user, must be a valid username and unique.

    Format should match the following pattern: /^[A-Z_a-z]\w*$/.

Responses

PATCH /api/profile 
curl \
 -X PATCH https://[tenant_id].logto.app/api/profile \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"name":"string","avatar":"string","username":"string"}'
Request examples 
{
  "name": "string",
  "avatar": "string",
  "username": "string"
}
Response examples (200) 
{
  "id": "string",
  "username": "string",
  "primaryEmail": "string",
  "primaryPhone": "string",
  "name": "string",
  "avatar": "string",
  "customData": {},
  "identities": {
    "additionalProperty1": {
      "userId": "string",
      "details": {}
    },
    "additionalProperty2": {
      "userId": "string",
      "details": {}
    }
  },
  "lastSignInAt": 42.0,
  "createdAt": 42.0,
  "updatedAt": 42.0,
  "profile": {
    "familyName": "string",
    "givenName": "string",
    "middleName": "string",
    "nickname": "string",
    "preferredUsername": "string",
    "profile": "string",
    "website": "string",
    "gender": "string",
    "birthdate": "string",
    "zoneinfo": "string",
    "locale": "string",
    "address": {
      "formatted": "string",
      "streetAddress": "string",
      "locality": "string",
      "region": "string",
      "postalCode": "string",
      "country": "string"
    }
  },
  "applicationId": "string",
  "isSuspended": true,
  "hasPassword": true,
  "ssoIdentities": [
    {
      "tenantId": "string",
      "id": "string",
      "userId": "string",
      "issuer": "string",
      "identityId": "string",
      "detail": {},
      "createdAt": 42.0,
      "ssoConnectorId": "string"
    }
  ]
}