search
☰

Preview

updateUser is in Preview status and is subject to change without notice. For more information about Preview status, see the GraphQL API policy.

updateUser

Updates a marketplace user

This page contains

    Authorization Rules

    This request requires authorization with at least one of the following scopes:

    Scopes

    ROLE_PARTNER

    ROLE_CHANNEL_ADMIN

    ROLE_CHANNEL_SUPPORT

    ROLE_CORPORATE_ADMIN

    ROLE_SYS_ADMIN

    ROLE_USER

    Arguments

    input UpdateUserInput! PREVIEW

    Input parameters for update marketplace user information

    UpdateUserInput fields

    id ID!

    The marketplace ID for the user

    email String

    The email address of the user

    externalId String

    An external identifier for the user

    firstName String

    The user's first name

    lastName String

    The user's last name

    ldapId String

    LDAP ID of the user

    locale Locale

    The user's locale. This combines the standard ISO 639-1 language code and ISO 3166-1 country code format. For example, 'en_US' or 'fr_CA'.

    username String PREVIEW

    Username of the user

    idpId String PREVIEW

    The external identity provider's ID for the user

    homePhone PhoneNumber

    Home phone number

    workPhone PhoneNumber

    Work phone number

    mobilePhone PhoneNumber

    Mobile phone number

    customAttributesInput CustomAttributesInput

    The input for updating custom attributes associated with the user's profile

    Return Fields

    user User PREVIEW
    userErrors [UpdateUserError!] PREVIEW

    Interactive example

    This is an example mutation query. Use the embedded interactive tool below to edit the query.

    Hint: use Ctrl + Space for autocompleting fields.