G-g-core
Users

Update user's details

Changed on

This method updates user's details.

patch/iam/users/{userId}

Request

  • Base URL
    https://api.gcore.com
  • URL
    https://api.gcore.com/iam/users/{userId}
  • Auth
    HTTP apikey

Path parameters

userIdinteger required

User's ID.

Request body

idinteger

User's ID.

emailstring email

User's email address.

namestring nullable

User's name.

lang'de' | 'en' | 'ru' | 'zh' | 'az'

User's language.

Defines language of the control panel and email messages.

phonestring nullable

User's phone.

resellerinteger

Services provider ID.

clientnumber

User's account ID.

deletedboolean

Deletion flag. If true then user was deleted.

activatedboolean

Email confirmation:

  • true – user confirmed the email;
  • false – user did not confirm the email.
sso_authboolean

SSO authentication flag. If true then user can login via SAML SSO.

two_faboolean

Two-step verification:

  • true – user enabled two-step verification;
  • false – user disabled two-step verification.
auth_typesAuthType[]

System field. List of auth types available for the account.

user_type'common' | 'reseller' | 'seller'

User's type.

is_activeboolean

User activity flag.

Example request

{
  "client_and_roles": [
    {
      "user_roles": [
        "2"
      ]
    }
  ]
}

Response

OK.

idinteger required

User's ID.

emailstring email required

User's email address.

namestring nullable required

User's name.

lang'de' | 'en' | 'ru' | 'zh' | 'az' required

User's language.

Defines language of the control panel and email messages.

phonestring nullable required

User's phone.

companystring required

User's company.

resellerinteger required

Services provider ID.

clientnumber required

User's account ID.

deletedboolean required

Deletion flag. If true then user was deleted.

activatedboolean required

Email confirmation:

  • true – user confirmed the email;
  • false – user did not confirm the email.
sso_authboolean required

SSO authentication flag. If true then user can login via SAML SSO.

two_faboolean required

Two-step verification:

  • true – user enabled two-step verification;
  • false – user disabled two-step verification.
auth_typesAuthType[] required

System field. List of auth types available for the account.

user_type'common' | 'reseller' | 'seller' required

User's type.

is_activeboolean required

User activity flag.

Example response

{
  "groups": [
    {
      "id": 1,
      "name": "Administrators"
    }
  ],
  "client_and_roles": [
    {
      "user_roles": [
        "2"
      ]
    }
  ]
}

Changes

  • 236958943262Revision changes
    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional