APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
ManagementUsersUsers company level

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

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

companyId*string

The unique identifier of the company account.

Request Body

application/json

accountGroups?array<string>

The list of account groups associated with this user.

associatedMerchantAccounts?array<string>

The list of merchant accounts associated with this user.

email*string

The email address of the user.

loginMethod?string

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

name*

The user's full name.

Allowed length: 1—80 characters.

Length1 <= length <= 80
roles?array<string>

The list of roles for this user.

timeZoneCode?string

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

username*string

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

Length1 <= length <= 255

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/companies/string/users" \  -H "Content-Type: application/json" \  -d '{    "name": {      "firstName": "John",      "lastName": "Smith"    },    "username": "johnsmith",    "email": "john.smith@example.com",    "loginMethod": "Email",    "timeZoneCode": "Europe/Amsterdam",    "roles": [      "Merchant standard role",      "Merchant admin"    ],    "associatedMerchantAccounts": [      "YOUR_MERCHANT_ACCOUNT"    ]  }'

Example response after creating a user on the company level

{  "id": "S2-5C334C6770",  "name": {    "firstName": "John",    "lastName": "Smith"  },  "email": "john.smith@example.com",  "timeZoneCode": "Europe/Amsterdam",  "username": "johnsmith",  "roles": [    "Merchant standard role",    "Merchant admin"  ],  "active": true,  "_links": {    "self": {      "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/users/S2-5C334C6770"    }  },  "associatedMerchantAccounts": [    "YOUR_MERCHANT_ACCOUNT"  ]}

Get a list of users GET

Returns the list of users for the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write

Get user details GET

Returns user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Users read and write