Add user.

curl --request POST \
  --url https://{tenant}/api/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "email_address": "itachi@gmail.com",
  "first_name": "itachi",
  "last_name": "sasuke",
  "user_permissions": {
    "analytics": "read",
    "api_assets": "write",
    "apis": "write",
    "certs": "write",
    "hooks": "write",
    "idm": "write",
    "keys": "write",
    "log": "read",
    "oauth": "write",
    "policies": "write",
    "portal": "write",
    "system": "write",
    "user_groups": "write",
    "users": "write",
    "websockets": "read"
  }
}
'

{
  "Message": "User and session have been created",
  "Meta": "6649a9e85715ec4c96cbef2f",
  "Status": "OK"
}

Users

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: itachi@gmail.com,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

Add user.

curl --request POST \
  --url https://{tenant}/api/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "email_address": "itachi@gmail.com",
  "first_name": "itachi",
  "last_name": "sasuke",
  "user_permissions": {
    "analytics": "read",
    "api_assets": "write",
    "apis": "write",
    "certs": "write",
    "hooks": "write",
    "idm": "write",
    "keys": "write",
    "log": "read",
    "oauth": "write",
    "policies": "write",
    "portal": "write",
    "system": "write",
    "user_groups": "write",
    "users": "write",
    "websockets": "read"
  }
}
'

{
  "Message": "User and session have been created",
  "Meta": "6649a9e85715ec4c96cbef2f",
  "Status": "OK"
}

Authorizations

Authorization

string

header

required

The Tyk Dashboard API Access Credentials

Body

application/json

email_address

string

required

Example:

"multi-org-user@example.org"

first_name

string

required

Example:

"itachi"

last_name

string

required

Example:

"sasuke"

user_permissions

object

required

Show child attributes

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"

string

Example:

"66498cd1e2fcd1000184ecb5"

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

User added successfully.

string

Message

string