On This Page
ASA Users API
Get started
The Advanced Server Access (ASA) API is logically separate from the rest of the Okta APIs and uses a different API namespace:
https://app.scaleft.com/v1/
An Advanced Server Access (ASA) User corresponds to a human or Service User in the ASA ecosystem.
Explore the Users API: 
(opens new window).
Users API operations
The Users API has the following operations:
- List the ASA Users for a team
- Fetch an ASA User
- Update an ASA User
- List ASA Groups that a specific ASA User is a member of
List the ASA Users for a team
GET https://app.scaleft.com/v1/teams/${team_name}/users
Lists the ASA Users for an ASA Team
This endpoint requires one of the following roles: access_user, access_admin, or reporting_user.
Request path parameters
| Parameter | Type | Description |
|---|---|---|
team_name | string | The name of your Team |
Request query parameters
| Parameter | Type | Description |
|---|---|---|
contains | string | (Optional) Includes ASA Users with name that contains the value |
count | number | (Optional) The number of objects per page |
descending | boolean | (Optional) The object order |
include_service_users | string | (Optional) Include Service Users in the results |
offset | string | (Optional) The UUID of the object used as an offset for pagination |
prev | boolean | (Optional) The direction of paging |
starts_with | string | (Optional) Includes ASA Users with name that begins with the value |
status | string | (Optional) Includes ASA Users with specified statuses. Valid statuses: ACTIVE, DISABLED, and DELETED. |
Request body
This endpoint has no request body.
Response body
This endpoint returns a list of objects with the following fields and a 200 code on a successful call.
| Properties | Type | Description |
|---|---|---|
deleted_at | string | The time at which the ASA User was deleted |
details | object | An object with the following keys, the values of which are all strings: first_name, last_name, full_name, and email |
id | string | The UUID of the ASA User |
name | string | The username of the ASA User |
oauth_client_application_id | string | The ID of the ASA User provided by OAuth, if it exists |
role_grants | array | The permission roles available to the ASA User |
status | string | Status of the ASA User: ACTIVE, DISABLED, or DELETED. ASA Users can't disable or delete their own ASA User. |
user_type | string | The type of ASA User: service or human |
Usage example
Request
curl -v -X GET \
-H "Authorization: Bearer ${jwt}" \
https://app.scaleft.com/v1/teams/${team_name}/users
Response
{
"list": [
{
"deleted_at": null,
"details": {
"email": "jason.compson@example.com",
"first_name": "Jason",
"full_name": "Jason Compson IV",
"last_name": "Compson"
},
"id": "9b30f827-66bb-4d86-ba26-d57f85c2a0d6",
"name": "Jason.Compson.IV",
"oauth_client_application_id": null,
"role_grants": null,
"status": "ACTIVE",
"user_type": "human"
},
{
"deleted_at": null,
"details": {
"email": "benjy.compson@example.com",
"first_name": "Benjy",
"full_name": "Benjy Compson",
"last_name": "Compson"
},
"id": "10593dce-5a88-462c-bba7-1666e0b401a3",
"name": "Benjy.Compson",
"oauth_client_application_id": null,
"role_grants": null,
"status": "DISABLED",
"user_type": "human"
},
{
"deleted_at": "1910-06-10T00:00:00Z",
"details": {
"email": "quentin.compson@example.com",
"first_name": "Quentin",
"full_name": "Quentin Compson III",
"last_name": "Compson"
},
"id": "4dee8f5f-a15e-400d-853c-a89850f051c1",
"name": "Quentin.Compson.III",
"oauth_client_application_id": null,
"role_grants": null,
"status": "DELETED",
"user_type": "human"
}
]
}
Fetch an ASA User
GET https://app.scaleft.com/v1/teams/${team_name}/users/${user_name}
Fetches information about a specific ASA User
This endpoint requires one of the following roles: access_user, access_admin, or reporting_user.
Request path parameters
| Parameter | Type | Description |
|---|---|---|
team_name | string | The name of your Team |
user_name | string | The relevant username |
Request query parameters
This endpoint has no query parameters.
Request body
This endpoint has no request body.
Response body
This endpoint returns an object with the following fields and a 200 code on a successful call.
| Properties | Type | Description |
|---|---|---|
deleted_at | string | The time at which the ASA User was deleted |
details | object | An object with the following keys, the values of which are all strings: first_name, last_name, full_name, and email |
id | string | The UUID of the ASA User |
name | string | The username of the ASA User |
oauth_client_application_id | string | The ID of the ASA User provided by OAuth, if it exists |
role_grants | array | The permission roles available to the ASA User |
status | string | Status of the ASA User: ACTIVE, DISABLED, or DELETED. ASA Users can't disable or delete their own ASA User. |
user_type | string | The type of ASA User: service or human |
Usage example
Request
curl -v -X GET \
-H "Authorization: Bearer ${jwt}" \
https://app.scaleft.com/v1/teams/${team_name}/users/${user_name}
Response
{
"deleted_at": null,
"details": {
"email": "jason.compson@example.com",
"first_name": "Jason",
"full_name": "Jason Compson IV",
"last_name": "Compson"
},
"id": "9b30f827-66bb-4d86-ba26-d57f85c2a0d6",
"name": "Jason.Compson.IV",
"oauth_client_application_id": null,
"role_grants": null,
"status": "ACTIVE",
"user_type": "human"
}
Update an ASA User
PUT https://app.scaleft.com/v1/teams/${team_name}/users/${user_name}
Updates a specific ASA User
This endpoint requires the access_admin role.
Request path parameters
| Parameter | Type | Description |
|---|---|---|
team_name | string | The name of your Team |
user_name | string | The relevant username |
Request query parameters
This endpoint has no query parameters.
Request body
This endpoint requires an object with the following fields.
| Properties | Type | Description |
|---|---|---|
deleted_at | string | The time at which the ASA User was deleted |
details | object | An object with the following keys, the values of which are all strings: first_name, last_name, full_name, and email |
id | string | The UUID of the ASA User |
name | string | The username of the ASA User |
oauth_client_application_id | string | The ID of the ASA User provided by OAuth, if it exists |
role_grants | array | The permission roles available to the ASA User |
status | string | Status of the ASA User: ACTIVE, DISABLED, or DELETED. ASA Users can't disable or delete their own ASA User. |
user_type | string | The type of ASA User: service or human |
Response body
This endpoint returns a 204 No Content response on a successful call.
Usage example
Request
curl -v -X PUT \
-H "Authorization: Bearer ${jwt}" \
--data '{
"deleted_at": null,
"details": {
"email": "James.compson@example.com",
"first_name": "James",
"full_name": "James Compson IV",
"last_name": "Compson"
},
"id": "9b30f827-66bb-4d86-ba26-d57f85c2a0d6",
"name": "James.Compson.IV",
"oauth_client_application_id": null,
"role_grants": null,
"status": "ACTIVE",
"user_type": "human"
}' \
https://app.scaleft.com/v1/teams/${team_name}/users/${user_name}
Response
HTTP 204 No Content
List ASA Groups that a specific ASA User is a member of
GET https://app.scaleft.com/v1/teams/${team_name}/users/${user_name}/groups
Lists the Groups that a specific ASA User belongs to
This endpoint requires one of the following roles: access_user, access_admin, or reporting_user.
Request path parameters
| Parameter | Type | Description |
|---|---|---|
team_name | string | The name of your Team |
user_name | string | The relevant username |
Request query parameters
| Parameter | Type | Description |
|---|---|---|
contains | string | (Optional) If a value is provided, the results are filtered to only contain ASA Groups whose name contains that value. |
count | number | (Optional) The number of objects per page |
descending | boolean | (Optional) The object order |
offset | string | (Optional) The UUID of the object used as an offset for pagination |
prev | boolean | (Optional) The direction of paging |
Request body
This endpoint has no request body.
Response body
This endpoint returns a list of objects with the following fields and a 200 code on a successful call.
| Properties | Type | Description |
|---|---|---|
deleted_at | string | The time at which the ASA Group was deleted |
federated_from_team | string | (Optional) The name of the Team from which to federate the ASA Group |
federation_approved_at | string | (Optional) The time when the ASA Group had its federation approved |
id | string | The UUID of the ASA Group |
name | string | The name of the ASA Group |
roles | array | A list of roles for the ASA Group. Options are access_user, access_admin, and reporting_user. |
Usage example
Request
curl -v -X GET \
-H "Authorization: Bearer ${jwt}" \
https://app.scaleft.com/v1/teams/${team_name}/users/${user_name}/groups
Response
{
"list": [
{
"deleted_at": "0001-01-01T00:00:00Z",
"federated_from_team": null,
"federation_approved_at": null,
"id": "5476abfe-5eaf-4f96-ac83-053b900bdccf",
"name": "compsons",
"roles": [
"access_user",
"reporting_user",
"access_admin"
]
}
]
}