Create a new user

post/companies/{companyId}/users

Creates the user for the companyId identified in the path.

To make this request, your API credential must have the following role:

  • Management API—Users read and write
Endpoint destination URL
https://management-test.adyen.com/v1/companies/{companyId}/users
Click to copy

Path Parameters

companyIdstringRequired

The unique identifier of the company account.

Request Parameters

accountGroupsarray[string]

The list of account groups associated with this user.

associatedMerchantAccountsarray[string]

The list of merchant accounts associated with this user.

emailstringRequired

The email address of the user.

loginMethodstring

The requested login method for the user. To use SSO, you must already have SSO configured with Adyen before creating the user.

Possible values: Username & account, Email, or SSO

nameobjectRequired
Min length: 1Max length: 80

The user's full name.

Allowed length: 1—80 characters.

rolesarray[string]

The list of roles for this user.

timeZoneCodestring

The tz database name of the time zone of the user. For example, Europe/Amsterdam.

usernamestringRequired
Min length: 1Max length: 255

The user's email address that will be their username. Must be the same as the one in the email field.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show moreShow less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less