Add user.

Create a user. If you want to create an admin user, you need to send {IsAdmin: admin} in the user_permissions field e.g ```{user_permissions: {IsAdmin: admin},last_name: sasuke,email_address: [e-mail],first_name: itachi}```. You can add a user to a given user-group by sending the group_id in the request body. If you want to give a user access only to specific objects e.g policies you can send the object and the permission granted to the user (read or write permission in the user_permissions field (check the request example given for more details)).

POST /api/users

Try it

Add user.

cURL

curl --request POST \
  --url https://{tenant}/api/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email_address": "[e-mail]",
  "first_name": "itachi",
  "last_name": "sasuke",
  "user_permissions": {},
  "access_key": "d7ebef749e4348cb67fec3cfc81f0a50",
  "active": true,
  "api_model": {},
  "created_at": "2024-05-19T08:23:29.034+03:00",
  "group_id": "5e9d9544a1dcd60001d0ed20",
  "id": "66498cd1e2fcd1000184ecb5",
  "last_login_date": "2024-05-19T08:42:22.659839+03:00",
  "org_id": "5e9d9544a1dcd60001d0ed20",
  "password_max_days": 0,
  "password_updated": "2024-05-19T08:23:29.146+03:00"
}
'

200

{
  "ID": "<string>",
  "Message": "<string>",
  "Meta": "<unknown>",
  "Status": "<string>"
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Body

application/json

email_address · string · required

Example:

"[e-mail]"

first_name · string · required

Example:

"itachi"

last_name · string · required

Example:

"sasuke"

user_permissions · object · required

Show child attributes

user_permissions. {key} · string

access_key · string

Example:

"d7ebef749e4348cb67fec3cfc81f0a50"

active · boolean

Example:

true

api_model · object

created_at · string<date-time>

Example:

"2024-05-19T08:23:29.034+03:00"

group_id · string

Example:

"5e9d9544a1dcd60001d0ed20"

id · string

Example:

"66498cd1e2fcd1000184ecb5"

last_login_date · string<date-time>

Example:

"2024-05-19T08:42:22.659839+03:00"

org_id · string

Example:

"5e9d9544a1dcd60001d0ed20"

password_max_days · integer

Example:

0

password_updated · string<date-time>

Example:

"2024-05-19T08:23:29.146+03:00"

Response

200

application/json

User added successfully.

ID · string

Message · string

Meta · any

Status · string