Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "sdk-identity/src/sdk/updateUserProfile"

Index

Functions

Functions

updateUserProfile

  • Parameters

    Returns Promise<UserProfile | APIErrorResponse>

    A Promise which resolves to the user's updated details. The userProfile property will be updated with this data.

    On success (resolves)
    {
      "firstName": "John",
      "lastName": "Doe",
      "secondLastName": "Doey",
      "displayName": "john_doe",
      "gender": "MALE, FEMALE",
      "email": "john.doe@donotreply.com",
      "picture": "KEY1",
      "birthYear": "1999",
      "birthMonth": "11",
      "birthDay": "15",
      "emailVerified": true,
      "contacts": [
        {
          "phone": "555-555-5555",
          "type": "WORK, HOME, PRIMARY, OTHER"
        }
      ],
      "addresses": [
        {
          "line1": "123 Main St.",
          "line2": "string",
          "locality": "string",
          "region": "string",
          "postal": "string",
          "country": "string",
          "type": "WORK, HOME, PRIMARY, OTHER"
        }
      ],
      "attributes": [
        {
          "name": "KEY1",
          "value": "VALUE 1",
          "type": "String, Number, Date, Boolean"
        }
      ],
      "identities": [
        {
          "createdOn": "2019-05-30T12:35:50.041Z",
          "createdBy": "string",
          "modifiedOn": "2019-05-30T12:35:50.042Z",
          "modifiedBy": "string",
          "deletedOn": "2019-05-30T12:35:50.042Z",
          "id": 1,
          "userName": "jdoe123",
          "passwordReset": true,
          "type": "Identity",
          "lastLoginDate": "2019-05-30T12:35:50.042Z",
          "locked": true
        }
      ],
      "legacyId": "FGE234UIR184",
      "uuid": "string"
    }
    On error (throws)
    See documentation for corresponding error codes:
    https://redirector.arcpublishing.com/alc/docs/swagger/?url=./arc-products/arc-identity-v1.json#/User_Registration/updateProfile