Clients

List all Clients
Admin roles:
  • access_user
  • access_admin
  • reporting_user

Returns a list of Clients for your Team. By default, this only returns Clients associated with the requesting User. Use query parameters to adjust the list of returned Clients.

SecuritybearerAuth
Request
path Parameters
team_name
required
string

The name of your Team

query Parameters
offset
string

The UUID of an object used as an offset for pagination

count
integer <int32>

Controls the number of objects listed per page

descending
boolean

If 'true', the most recent results are listed first

prev
boolean

Controls the direction of paging

all
boolean

If 'true', returns all Clients enrolled in your Team

state
string

If defined, results only include Clients with the specified status. Possible values: 'ACTIVE', 'PENDING', or 'DELETED'.

username
string

If defined, results include Clients assigned to the specified User. If an empty string is defined, the results include all unassigned Clients.

Responses
200

OK

get/v1/teams/{team_name}/clients
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      },
    • {
      }
    ]
}
Retrieve a Client
Admin roles: 
  • access_user
  • access_admin
  • reporting_user
Retrieves the properties of a specified Client


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
client_id
required
string
The UUID of the Client


 
Responses 
200
OK


get/v1/teams/{team_name}/clients/{client_id}
Request samples 
Response samples 
application/json
{
  • "deleted_at": null,
  • "description": "Work laptop",
  • "encrypted": true,
  • "hostname": "LightInAugust",
  • "id": "9c199afe-0ca5-427a-baac-c4341707d82b",
  • "os": "macOS 10.14.6",
  • "state": "PENDING",
  • "user_name": "Jason.Compson.IV"
}
Update a Client
Admin roles: 
  • access_admin
Updates the state or assigned user for a specified Client. This is required for some enrollment policies. See Silently enroll the Client.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
client_id
required
string
The UUID of the Client


 
Request Body schema: application/json
required
state
string or null  <= 255 characters 
The state of the Client: ACTIVE, PENDING, or DELETED


 
user_name
string or null  <= 255 characters 
The User associated with the Client


 
Responses 
204
No Content


put/v1/teams/{team_name}/clients/{client_id}
Request samples 
application/json
{
  • "state": "ACTIVE",
  • "user_name": "Jason.Compson.IV"
}
Revoke access to a Client
Admin roles: 
  • access_user
  • access_admin
Revokes access to a specified Client from your Team


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
client_id
required
string
The UUID of the Client


 
Responses 
204
No Content


delete/v1/teams/{team_name}/clients/{client_id}
Request samples