User

APIs for User management

User information

User information

SecurityapiKey
Request
header Parameters
X-Client-Id
string

client id registered with AuthN

X-Tenant
string

Tenant name

Responses
200

User Info

401

Authorization information is missing or invalid

500

Internal server error

get/user_info/
Response samples
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "full_name": "string",
  • "is_staff": true,
  • "is_superuser": true,
  • "is_active": true,
  • "profile": {
    },
  • "emm": {
    },
  • "last_login": "string",
  • "token": "string",
  • "has_emm": true,
  • "is_email_verified": true
}

List users in Enterprise

SecurityapiKey
Responses
200

Users List

401

Authorization information is missing or invalid

500

Internal server error

get/user/
Response samples
application/json
{
  • "count": 0,
  • "previous": "string",
  • "next": "string",
  • "results": [
    ]
}

Create a new User

Create a new User

SecurityapiKey
Request
Request Body schema: application/json
username
required
string (User name)
password
string (Password)
first_name
string (First name)
last_name
string (Last name)
is_active
boolean (Is user active)
email
string <email> (Email)
required
object (UserProfile)
Responses
201

User Created

400

Bad request

401

Authorization information is missing or invalid

403

Forbidden, no permission to perform this action

500

Internal server error

post/user/
Request samples
application/json
{
  • "username": "string",
  • "password": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "email": "user@example.com",
  • "profile": {
    }
}
Response samples
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "full_name": "string",
  • "is_staff": true,
  • "is_superuser": true,
  • "is_active": true,
  • "profile": {
    },
  • "emm": {
    },
  • "last_login": "string",
  • "token": "string",
  • "has_emm": true,
  • "is_email_verified": true
}

Get User Information

Get User Information

SecurityapiKey
Request
path Parameters
user_id
required
integer

User ID

Responses
200

User Details

401

Authorization information is missing or invalid

404

Not Found

500

Internal server error

get/user/{user_id}/
Response samples
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "full_name": "string",
  • "is_staff": true,
  • "is_superuser": true,
  • "is_active": true,
  • "profile": {
    },
  • "emm": {
    },
  • "last_login": "string",
  • "token": "string",
  • "has_emm": true,
  • "is_email_verified": true
}

Update a User

Update a User

SecurityapiKey
Request
path Parameters
user_id
required
integer

User ID

Request Body schema: application/json
username
required
string (User name)
password
string (Password)
first_name
string (First name)
last_name
string (Last name)
is_active
boolean (Is user active)
email
string <email> (Email)
required
object (UserProfile)
Responses
200

Updated User

400

Bad request

401

Authorization information is missing or invalid

403

Forbidden, no permission to perform this action

404

Not Found

500

Internal server error

put/user/{user_id}/
Request samples
application/json
{
  • "username": "string",
  • "password": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "email": "user@example.com",
  • "profile": {
    }
}
Response samples
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "full_name": "string",
  • "is_staff": true,
  • "is_superuser": true,
  • "is_active": true,
  • "profile": {
    },
  • "emm": {
    },
  • "last_login": "string",
  • "token": "string",
  • "has_emm": true,
  • "is_email_verified": true
}

Partial update a User

Partial update a User

SecurityapiKey
Request
path Parameters
user_id
required
integer

User ID

Request Body schema: application/json
username
string (User name)
password
string (Password)
first_name
string (First name)
last_name
string (Last name)
is_active
boolean (Is user active)
email
string <email> (Email)
object (UserProfile)
Responses
200

Partial updated User

400

Bad request

401

Authorization information is missing or invalid

403

Forbidden, no permission to perform this action

404

Not Found

500

Internal server error

patch/user/{user_id}/
Request samples
application/json
{
  • "username": "string",
  • "password": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "is_active": true,
  • "email": "user@example.com",
  • "profile": {
    }
}
Response samples
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "full_name": "string",
  • "is_staff": true,
  • "is_superuser": true,
  • "is_active": true,
  • "profile": {
    },
  • "emm": {
    },
  • "last_login": "string",
  • "token": "string",
  • "has_emm": true,
  • "is_email_verified": true
}

Delete a user

SecurityapiKey
Request
path Parameters
user_id
required
integer

User ID

Responses
204

Deleted User

401

Authorization information is missing or invalid

403

Forbidden, no permission to perform this action.

404

Not Found

500

Internal server error

delete/user/{user_id}/
Response samples
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}