Skip to content

Update user

Use the Update user operation to update a user in your Mosaic app.

Operation parameters

Note

For the purpose of creating a user, the following fields should be set as follows:

  • Credentials to connect with: The Client ID and Client Secret of any application in your tenant. Retrieve the credentials from any application in your tenant (available in the application settings). These credentials are not scoped to a specific app—they grant access to the entire tenant. Once saved, the credentials are stored as a Mosaic account and can be updated at any time.
  • Resource: Identity management
  • Operation: Update User

The Add Field: allows you to select the user information to update:

  • email: Primary email address of the user
  • phone_number: Primary phone number of the user, specified in E.164 format
  • username: Username used to identify the user
  • secondary_emails: Secondary email addresses to add to user's current emails
  • secondary_phone_numbers: Secondary phone numbers to add to user's phone numbers, each specified in E.164 format
  • birthday: User's birthday (string <date-time>)
  • address: User's address
    • country: Country of the user
    • state: State of the user
    • city: City of the user
    • street_address: Street address of the user
    • postal_code: Postal code of the user
    • type: Type of address (e.g., Home)
  • name: Object describing user's full name
    • title: Title of the user
    • first_name: First name of the user
    • last_name: Last name of the user
    • middle_name: Middle name of the user
  • external_account_id: User identifier in an app, set by the app
  • custom_app_data: Custom data object for app-related user info
  • picture: The picture of user, specified as a URL
  • language: The language of the user, as provided by the browser using the Accept-Language header field
  • custom_data: Custom data object for tenant user info
  • external_user_id: A unique identifier in a tenant
  • delegated_access: If this user is a dependent, this defines the permissions that the primary user will have to act on behalf of the dependent user
    • actor_id: Identifier of the primary user
    • permissions: List of permissions the primary user will have
  • language
  • custom data
  • credentials
  • external user id

Result

As the Transmit node is run, the user is updated. The Result displays the updated details (e.g. phone\_number and its updated value). Note that the same parameters are returned, now including some metadata:

email:

  • value: The updated primary email address of the user
  • email_verified: Indicates if the primary email is verified
  • verified_at: The date and time when the primary email was verified secondary_emails:
  • value: The updated secondary email addresses of the user
  • email_verified: Indicates if the secondary email is verified
  • verified_at: The date and time when the secondary email was verified phone_number:
  • value: The updated primary phone number of the user
  • phone_number_verified: Indicates if the primary phone number is verified
  • verified_at: The date and time when the primary phone number was verified secondary_phone_numbers:
  • value: The updated secondary phone numbers of the user
  • phone_number_verified: Indicates if the secondary phone number is verified
  • verified_at: The date and time when the secondary phone number was verified user_id: The ID of the updated user status: The updated status of the user status_changed_at: The date and time when the user's status was last changed created_at: The date and time when the user was created updated_at: The date and time when the user was last updated identity_providers:
  • source: The source of the identity provider
  • identifier: The identifier of the identity provider
  • email: The email associated with the identity provider
  • first_auth_date: The first authentication date with the identity provider
  • last_auth_date: The last authentication date with the identity provider identities:
  • provider_name: The name of the identity provider
  • provider_type: The type of the identity provider
  • auth_type: The authentication type of the identity provider
  • identifier: The identifier of the identity provider
  • user_alias:
    • type: The type of user alias
    • value: The value of the user alias
  • first_auth_date: The first authentication date with the identity provider
  • last_auth_date: The last authentication date with the identity provider last_auth: The last authentication date of the user app_name: The name of the application groupIds: The group IDs associated with the user password_information:
  • expired: Indicates if the password is expired
  • temporary: Indicates if the password is temporary
  • updated_at: The date and time when the password was last updated