On This Page
ASA Teams 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) Team is the top-level organizational concept in ASA. Each ASA Team maps to a single app in the Okta dashboard.
All other configuration objects in Advanced Server Access are scoped to an ASA Team.
Explore the Teams API: 
(opens new window).
Teams API operations
The Teams API has the following operations:
List Servers for a Team
GET https://app.scaleft.com/v1/teams/${team_name}/servers
Lists all the Servers enrolled in a Team that the requesting ASA User has access to
This endpoint requires one of the following roles: access_user, access_admin, authenticated_client, reporting_user, or server_admin.
Request path parameters
| Parameter | Type | Description |
|---|---|---|
team_name | string | The name of your Team |
Request query parameters
| Parameter | Type | Description |
|---|---|---|
alt_names_contains | string | (Optional) Include Servers that contain the value of alt_name_contains in their alt_names |
bastion | string | (Optional) A bastion hostname |
canonical_name | string | (Optional) A canonical name |
cloud_provider | string | (Optional) A Cloud provider: aws or gcp |
count | number | (Optional) The number of objects per page |
descending | boolean | (Optional) The object order |
hostname | string | (Optional) A hostname |
offset | string | (Optional) The UUID of the object used as an offset for pagination |
prev | boolean | (Optional) The direction of paging |
project_name | string | (Optional) A Project name |
selector | string | (Optional) Server selectors. Same syntax as k8s |
state | string | (Optional) State of the Server: ACTIVE or INACTIVE |
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 |
|---|---|---|
access_address | string | The access address of the Server |
alt_names | array | (Optional) Alternative names for the Server |
bastion | string | Specifies the bastion host that Clients automatically use when connecting to this host |
canonical_name | string | Specifies the name that Clients should use/see when connecting to this host. Overrides the name found with hostname. |
cloud_provider | string | The cloud provider of the Server, if one exists |
deleted_at | string | The time the Server was deleted from the Project |
hostname | string | The hostname of the Server |
id | string | The UUID corresponding to the Server |
instance_details | object | Information that the cloud provider provides about the Server, if one exists |
last_seen | string | The last time that the Server made a request to the ASA platform |
managed | boolean | True if the Server is managed by 'sftd'. Unmanaged Servers are used in configurations where users may have a bastion, for example, that they don't want/can't connect to through 'sftd'. With an Unmanaged Server record to represent this box, ASA knows that it exists and to use it as a bastion hop. |
os | string | The particular OS of the Server, such as CentOS 6 or Debian 9.13 |
os_type | string | The OS family where the Server is running. Can be either Linux or Windows. |
project_name | string | The Project that the Server belongs to |
registered_at | string | The time that the Server was registered to the Project |
services | array | The service that Clients use to connect to the Server. Can either be ssh or rdp. |
sftd_version | string | The version of 'sftd' that the Server is running |
ssh_host_keys | array | The host keys used to authenticate the Server |
state | string | State of the Server: ACTIVE or INACTIVE |
team_name | string | The name of the Team |
Usage example
Request
curl -v -X GET \
-H "Authorization: Bearer ${jwt}" \
https://app.scaleft.com/v1/teams/${team_name}/servers
Response
{
"list": [
{
"access_address": null,
"alt_names": null,
"bastion": null,
"canonical_name": null,
"cloud_provider": null,
"deleted_at": "0001-01-01T00:00:00Z",
"hostname": "harvard",
"id": "0a49a1cf-c747-47a0-bb14-94b1edb9f3ee",
"instance_details": null,
"last_seen": "0001-01-01T00:00:00Z",
"managed": true,
"os": "Ubuntu 16.04",
"os_type": "linux",
"project_name": "the-sound-and-the-fury",
"registered_at": "0001-01-01T00:00:00Z",
"services": [
"ssh"
],
"sftd_version": "1.44.4",
"ssh_host_keys": null,
"state": "INACTIVE",
"team_name": "william-faulkner"
},
{
"access_address": null,
"alt_names": null,
"bastion": null,
"canonical_name": null,
"cloud_provider": null,
"deleted_at": "0001-01-01T00:00:00Z",
"hostname": "jefferson",
"id": "ac68cb70-e3eb-4239-b6de-73d3878dd97b",
"instance_details": null,
"last_seen": "0001-01-01T00:00:00Z",
"managed": true,
"os": "Ubuntu 16.04",
"os_type": "linux",
"project_name": "the-sound-and-the-fury",
"registered_at": "0001-01-01T00:00:00Z",
"services": [
"ssh"
],
"sftd_version": "1.44.4",
"ssh_host_keys": null,
"state": "INACTIVE",
"team_name": "william-faulkner"
}
]
}
Fetch Team settings
GET https://app.scaleft.com/v1/teams/${team_name}/settings
Fetches Team-level settings for a specific Team, such as authentication and enrollment details
This endpoint requires one of the following roles: access_admin, instance_admin, or access_user.
Request path parameters
| Parameter | Type | Description |
|---|---|---|
team_name | string | The name of your Team |
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 |
|---|---|---|
approve_device_without_interaction | boolean | If enabled, ASA auto-approves devices for ASA Users that are authenticated into this Team. |
client_session_duration | number | Defines the Client session duration. Values should be in hours between 1 hour 25 hours. |
post_device_enrollment_url | string | If post device enrollment is configured, this is the URL that an ASA User is directed to after enrolling a device in ASA. |
post_login_url | string | If post login is configured, this is the URL that an ASA User who hasn't recently been authenticated is directed to after being validated by their IdP. |
post_logout_url | string | If post logout is configured, this is the URL that an ASA User is redirected to after signing out. |
reactivate_users_via_idp | boolean | If a disabled or deleted ASA User is able to authenticate through the IdP, their ASA User is re-enabled. |
team | string | The name of the Team that is configured with the provided settings |
user_provisioning_exact_username | boolean | If true, ASA has ASA Users configured through SCIM to maintain the exact username that is specified. |
web_session_duration | number | Defines the duration of the web session. Configure the web session to be between 30 minutes and 25 hours. |
Usage example
Request
curl -v -X GET \
-H "Authorization: Bearer ${jwt}" \
https://app.scaleft.com/v1/teams/${team_name}/settings
Response
{
"approve_device_without_interaction": false,
"client_session_duration": 36000,
"post_device_enrollment_url": null,
"post_login_url": null,
"post_logout_url": null,
"reactivate_users_via_idp": false,
"team": "william-faulkner",
"user_provisioning_exact_username": null,
"web_session_duration": 36000
}
Update Team settings
PUT https://app.scaleft.com/v1/teams/${team_name}/settings
Updates ream-level settings. Partial updates are permitted. URL parameters are optional and default to unset. To unset a previously set URL, use PUT with the unset parameter set to null.
This endpoint requires one of the following roles: access_admin, or instance_admin.
Request path parameters
| Parameter | Type | Description |
|---|---|---|
team_name | string | The name of your Team |
Request query parameters
This endpoint has no query parameters.
Request body
This endpoint requires an object with the following fields.
| Properties | Type | Description |
|---|---|---|
approve_device_without_interaction | boolean | If enabled, ASA auto-approves devices for ASA Users that are authenticated into this Team. |
client_session_duration | number | Defines the Client session duration. Values should be in hours between 1 hour 25 hours. |
post_device_enrollment_url | string | If post device enrollment is configured, this is the URL that an ASA User is directed to after enrolling a device in ASA. |
post_login_url | string | If post login is configured, this is the URL that an ASA User who hasn't recently been authenticated is directed to after being validated by their IdP. |
post_logout_url | string | If post logout is configured, this is the URL that an ASA User is redirected to after signing out. |
reactivate_users_via_idp | boolean | If a disabled or deleted ASA User is able to authenticate through the IdP, their ASA User is re-enabled. |
team | string | The name of the Team that is configured with the provided settings |
user_provisioning_exact_username | boolean | If true, ASA has ASA Users configured through SCIM to maintain the exact username that is specified. |
web_session_duration | number | Defines the duration of the web session. Configure the web session to be between 30 minutes and 25 hours. |
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 '{
"approve_device_without_interaction": false,
"client_session_duration": 600,
"post_device_enrollment_url": null,
"post_login_url": null,
"post_logout_url": null,
"reactivate_users_via_idp": false,
"team": "william-faulkner",
"user_provisioning_exact_username": null,
"web_session_duration": 600
}' \
https://app.scaleft.com/v1/teams/${team_name}/settings
Response
HTTP 204 No Content
Fetch statistics for a Team
GET https://app.scaleft.com/v1/teams/${team_name}/team_stats
Fetches general statistics about a Team
This endpoint requires the access_admin role.
Request path parameters
| Parameter | Type | Description |
|---|---|---|
team_name | string | The name of your Team |
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 |
|---|---|---|
num_clients | number | The number of Clients in a Team |
num_gateways | number | The number of Gateways in a Team |
num_groups | number | The number of ASA Groups in a Team |
num_human_users | number | The number of human ASA Users in a Team |
num_projects | number | The number of Projects in a Team |
num_servers | number | The number of Servers in a Team |
num_service_users | number | The number of service ASA Users in a Team |
Usage example
Request
curl -v -X GET \
-H "Authorization: Bearer ${jwt}" \
https://app.scaleft.com/v1/teams/${team_name}/team_stats
Response
{
"num_clients": 0,
"num_gateways": 0,
"num_groups": 1,
"num_human_users": 1,
"num_projects": 2,
"num_servers": 1,
"num_service_users": 0
}