Skip to main content
POST
/
api
/
v1
/
auth
/
users
/
by-permission
cURL
curl --request POST \
  --url https://api.example.com/api/v1/auth/users/by-permission \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone_number": "<string>",
  "status": "<string>",
  "date_joined": "2023-11-07T05:31:56Z",
  "last_login": "2023-11-07T05:31:56Z"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "username": "<string>",
  "name": "<string>",
  "inactive_alert": true,
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone_number": "<string>",
  "status": "<string>",
  "date_joined": "2023-11-07T05:31:56Z",
  "last_login": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.capedigital.co.ke/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Enter your JWT token in the format: Bearer

Body

Serializer for listing users with department information.

username
string
required
Required string length: 1 - 150
Pattern: ^[\w.@+-]+$
email
string<email>
Maximum string length: 254
first_name
string
Maximum string length: 150
last_name
string
Maximum string length: 150
phone_number
string
Maximum string length: 50
status
string
Required string length: 1 - 20
date_joined
string<date-time>
last_login
string<date-time> | null

Response

200 - application/json

Serializer for listing users with department information.

id
string<uuid>
required
read-only
username
string
required
Maximum string length: 150
Pattern: ^[\w.@+-]+$
name
string
required
read-only
inactive_alert
boolean
required
read-only

True if the user has not logged in for 2 or more business days (Mon–Fri).

None last_login (never logged in) is also treated as inactive.

email
string<email>
Maximum string length: 254
first_name
string
Maximum string length: 150
last_name
string
Maximum string length: 150
phone_number
string
Maximum string length: 50
status
string
Maximum string length: 20
date_joined
string<date-time>
last_login
string<date-time> | null