Gateways

An Okta Privileged Access gateway controls access to servers in your project.

See Okta Privileged Access gateways.

List all gateway setup tokens
Admin roles:
  • resource_admin

Lists all gateway setup tokens for your team

SecuritybearerAuth
Request
path Parameters
team_name
required
string

The name of your team

query Parameters
count
integer <int32>

The number of objects per page

descending
boolean

The object order

offset
string

The offset value for pagination. The rel="next" and rel="prev" Link headers define the offset for subsequent or previous pages.

prev
boolean

The direction of paging

Responses
200

OK

get/v1/teams/{team_name}/gateway_setup_tokens
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      },
    • {
      }
    ]
}
Create a gateway setup token
Admin roles: 
  • resource_admin
Creates a gateway setup token for your team


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


 
Request Body schema: application/json
required
description
string or null  [ 1 .. 1024 ] characters 
The description for the gateway setup token


 
required
object
An object that defines the labels applied to associated gateways


 
object or null
 
property name*
additional property
string
 
name
string <regex>   [ 1 .. 255 ] characters ^[\w\-_.]+$
The name for the gateway setup token


 
registration_type
required
string
The type of registration policy


 Value: "gateway-agent"  
Responses 
201
Created


post/v1/teams/{team_name}/gateway_setup_tokens
Request samples 
application/json
{
  • "labels": {
    • "env": "dev",
    • "region": "us-west-2"
    }
}
Response samples 
application/json
{
  • "created_at": "2023-08-25T12:00:00.000000Z",
  • "description": "Gateway Token 1",
  • "details": {
    • "labels": {
      }
    },
  • "id": "b09ba4db-d5b4-4ec5-90da-188e1d13d467",
  • "name": "ProductionGateway",
  • "registration_type": "gateway-agent",
  • "token": "sft-gw.342c346c-256e-49d5-8db4-426426eqe26e4.eyJhdCI6ImZ5X2lZMnFmVk1TcHJQcDlUSEh0MS1SR240ae9OOXZsSXEwUWhoNlNnSnciLCJhcyI6Imh0dHBzO0123GFtLXByb2R1Y3QtdGMxLnBhbS50cmV4Y2xvdWQuY29tposeL2FzL2FnZW50IiwicnMiOiJodHRwczovL3BhbS1wcm9kdWN0LXRjMS5wYW0udHJleGNsb3VkLmNvabc2MSyq"
}
Retrieve a gateway setup token
Admin roles: 
  • resource_admin
Retrieves the specified gateway setup token


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


 
gateway_setup_token_id
required
string
The UUID of a gateway setup token


 
Responses 
200
OK


get/v1/teams/{team_name}/gateway_setup_tokens/{gateway_setup_token_id}
Request samples 
Response samples 
application/json
{
  • "created_at": "2023-08-25T12:00:00.000000Z",
  • "description": "Gateway Token 1",
  • "details": {
    • "labels": {
      }
    },
  • "id": "b09ba4db-d5b4-4ec5-90da-188e1d13d467",
  • "name": "ProductionGateway",
  • "registration_type": "gateway-agent",
  • "token": "sft-gw.342c346c-256e-49d5-8db4-426426eqe26e4.eyJhdCI6ImZ5X2lZMnFmVk1TcHJQcDlUSEh0MS1SR240ae9OOXZsSXEwUWhoNlNnSnciLCJhcyI6Imh0dHBzO0123GFtLXByb2R1Y3QtdGMxLnBhbS50cmV4Y2xvdWQuY29tposeL2FzL2FnZW50IiwicnMiOiJodHRwczovL3BhbS1wcm9kdWN0LXRjMS5wYW0udHJleGNsb3VkLmNvabc2MSyq"
}
Delete a gateway setup token
Admin roles: 
  • resource_admin
Deletes the specified gateway setup token


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


 
gateway_setup_token_id
required
string
The UUID of a gateway setup token


 
Responses 
204
No Content


delete/v1/teams/{team_name}/gateway_setup_tokens/{gateway_setup_token_id}
Request samples 
Retrieve a gateway setup token
Admin roles: 
  • resource_admin
Retrieves the specified gateway setup token


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


 
gateway_setup_token_id
required
string
The UUID of a gateway setup token


 
Responses 
200
OK


get/v1/teams/{team_name}/gateway_setup_tokens/{gateway_setup_token_id}/token
Request samples 
Response samples 
application/json
{
  • "created_at": "2023-08-25T12:00:00.000000Z",
  • "description": "Gateway Token 1",
  • "details": {
    • "labels": {
      }
    },
  • "id": "b09ba4db-d5b4-4ec5-90da-188e1d13d467",
  • "name": "ProductionGateway",
  • "registration_type": "gateway-agent",
  • "token": "sft-gw.342c346c-256e-49d5-8db4-426426eqe26e4.eyJhdCI6ImZ5X2lZMnFmVk1TcHJQcDlUSEh0MS1SR240ae9OOXZsSXEwUWhoNlNnSnciLCJhcyI6Imh0dHBzO0123GFtLXByb2R1Y3QtdGMxLnBhbS50cmV4Y2xvdWQuY29tposeL2FzL2FnZW50IiwicnMiOiJodHRwczovL3BhbS1wcm9kdWN0LXRjMS5wYW0udHJleGNsb3VkLmNvabc2MSyq"
}
List all gateways
Admin roles: 
  • resource_admin
  • delegated_resource_admin
Lists all gateways for your team


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


 
query Parameters
contains
string
Only return results that include the specified value


 
count
integer <int32> 
The number of objects per page


 
descending
boolean
The object order


 
offset
string
The offset value for pagination. The rel="next" and rel="prev" Link headers define the offset for subsequent or previous pages.


 
prev
boolean
The direction of paging


 
Responses 
200
OK


get/v1/teams/{team_name}/gateways
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      },
    • {
      }
    ]
}
Retrieve a gateway
Admin roles: 
  • resource_admin
  • delegated_resource_admin
Retrieves the properties of a specified gateway


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


 
gateway_id
required
string
The UUID of a gateway


 
Responses 
200
OK


get/v1/teams/{team_name}/gateways/{gateway_id}
Request samples 
Response samples 
application/json
{
  • "access_address": "192.168.190.144:7234",
  • "cloud_provider": "aws",
  • "default_address": "192.168.19.32",
  • "description": "string",
  • "id": "d4f40b71-9474-41c5-94ff-3196a4fc2d03",
  • "labels": {
    • "property1": "string",
    • "property2": "string"
    },
  • "last_seen": "2023-08-25T13:00:00.000000Z",
  • "name": "ProductionGateway",
  • "refuse_connections": false
}
Update a gateway
Admin roles: 
  • resource_admin
Updates a specified gateway


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


 
gateway_id
required
string
The UUID of a gateway


 
Request Body schema: application/json
required
access_address
string
The IP address used to access the gateway


 
default_address
string
The default IP address used to access the gateway. This is generally supplied by the network interface or cloud provider metadata.


 
description
string or null  [ 1 .. 1024 ] characters 
The description of the gateway


 
required
object
The labels associated with the gateway. Used by projects to select gateways.


 
property name*
additional property
string
 
name
required
string <regex>   [ 1 .. 255 ] characters ^[\w\-_.]+$
The name for the gateway


 
Responses 
204
No Content


put/v1/teams/{team_name}/gateways/{gateway_id}
Request samples 
application/json
{
  • "access_address": "192.168.190.144:7234",
  • "default_address": "192.168.19.32",
  • "description": "string",
  • "labels": {
    • "property1": "string",
    • "property2": "string"
    },
  • "name": "ProductionGateway"
}
Delete a gateway
Admin roles: 
  • resource_admin
Deletes the specified gateway from your team


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


 
gateway_id
required
string
The UUID of a gateway


 
Responses 
204
No Content


delete/v1/teams/{team_name}/gateways/{gateway_id}
Request samples 
Retrieve a status report for a gateway
Admin roles: 
  • resource_admin
  • delegated_resource_admin
Retrieve a status report for the specified gateway


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


 
gateway_id
required
string
The UUID of a gateway


 
Responses 
200
OK


get/v1/teams/{team_name}/gateways/{gateway_id}/status
Request samples 
Response samples 
application/json
{
  • "active_connections": 2,
  • "gateway_id": "3b0fdbdd-1282-440d-a973-ddc409d6d743",
  • "status": "ONLINE",
  • "total_storage_bytes": 4096,
  • "updated_at": "0001-01-01T00:00:00Z",
  • "used_storage_bytes": 2048
}