Users

Retrieve information about the current User

Retrieves information about the User that is invoking the API

SecuritybearerAuth
Request
path Parameters
team_name
required
string

The name of your Team

Responses
200

OK

get/v1/teams/{team_name}/current_user
Request samples 
Response samples 
application/json
{
  • "id": "305b1bd8-b783-4351-a2b6-204248c9ea46",
  • "name": "Jason.Compson.IV",
  • "team_name": "william-faulkner"
}
List all Users for a Team
Admin roles: 
  • access_user
  • access_admin
  • reporting_user
Lists all Users for your Team


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


 
starts_with
string
Includes ASA Users with name that begins with the value


 
status
string
Includes ASA Users with specified statuses. Valid statuses: 'ACTIVE', 'DISABLED', and 'DELETED'.


 
contains
string
Includes ASA Users with name that contains the value


 
include_service_users
string
Include Service Users in the results


 
id
string
Include only users with the given IDs


 
Responses 
200
OK


get/v1/teams/{team_name}/users
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      },
    • {
      },
    • {
      }
    ]
}
Retrieve a User
Admin roles: 
  • access_user
  • access_admin
  • reporting_user
Retrieves a User from your Team


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


 
user_name
required
string
The relevant username


 
Responses 
200
OK


get/v1/teams/{team_name}/users/{user_name}
Request samples 
Response samples 
application/json
{
  • "deleted_at": null,
  • "details": {
    • "email": "jason.compson@example.com",
    • "first_name": "Jason",
    • "full_name": "Jason Compson IV",
    • "last_name": "Compson"
    },
  • "id": "6768ef2e-9a17-42ce-bf9a-a3a7242bd159",
  • "name": "Jason.Compson.IV",
  • "status": "ACTIVE",
  • "team_name": "william-faulkner",
  • "user_type": "human"
}
Update a User
Admin roles: 
  • access_admin
Updates a User from your Team


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


 
user_name
required
string
The relevant username


 
Request Body schema: application/json
required
object or null
The details of the User


 
email
string or null <regex>   [ 1 .. 255 ] characters ^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9]...
 
first_name
string or null  [ 1 .. 255 ] characters 
 
full_name
string or null  [ 1 .. 512 ] characters 
 
last_name
string or null  [ 1 .. 255 ] characters 
 
name
required
string  [ 1 .. 255 ] characters 
The username of the User


 
status
required
string
The status of the User: ACTIVE, DISABLED, or DELETED. Users can't disable or delete their own account.


 
Responses 
204
No Content


put/v1/teams/{team_name}/users/{user_name}
Request samples 
application/json
{
  • "deleted_at": null,
  • "details": {
    • "email": "James.compson@example.com",
    • "first_name": "James",
    • "full_name": "James Compson IV",
    • "last_name": "Compson"
    },
  • "id": "6768ef2e-9a17-42ce-bf9a-a3a7242bd159",
  • "name": "James.Compson.IV",
  • "status": "ACTIVE",
  • "team_name": "william-faulkner",
  • "user_type": "human"
}
List all Groups for a User
Admin roles: 
  • access_user
  • access_admin
  • reporting_user
Lists all Groups for a specified User


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


 
user_name
required
string
The relevant username


 
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


 
contains
string
If defined, results only include Groups that use the specified value in their name


 
include_deleted
boolean
If 'true', results also include previously deleted Groups


 
only_include_deleted
boolean
If 'true', results only include previously deleted Groups


 
disconnected_mode_on_only
boolean
If 'true', results only include Groups that have enabled disconnected mode


 
id
string
If defined, results only include Groups with the specified IDs


 
ignore
string
If defined, results don't include Groups with the specified names. This is case sensitive.


 
Responses 
200
OK


get/v1/teams/{team_name}/users/{user_name}/groups
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      }
    ]
}