Services

End of Sale Announcement

Effective May 1, 2026, Okta will no longer sell or renew Advanced Server Access. Existing customers must migrate to Okta Privileged Access within one year of their next scheduled renewal date to maintain service. Read the FAQ | Learn about Okta Privileged Access

List all Services for a Server
Admin roles:
  • access_user
  • access_admin
  • server_admin
  • reporting_user

Lists all Services available for a specified Server

SecuritybearerAuth
Request
path Parameters
team_name
required
string

The name of your Team

project_name
required
string

The Project name

server_id
required
string

The UUID of the Server

Responses
200

OK

get/v1/teams/{team_name}/projects/{project_name}/servers/{server_id}/services
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      },
    • {
      }
    ]
}
Create a Service
Admin roles: 
  • access_admin
Creates a Service that allows Service Users to access the specified Server


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


 
project_name
required
string
The Project name


 
server_id
required
string
The UUID of the Server


 
Request Body schema: application/json
required
server_uid
required
string  [ 1 .. 255 ] characters 
The UID of the Server User associated with the Service User


 
service_user_id
required
string <regex> ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-...
The UUID of the Service User associated with the Service


 
Responses 
201
Created


post/v1/teams/{team_name}/projects/{project_name}/servers/{server_id}/services
Request samples 
application/json
{
  • "server_uid": "9001",
  • "service_user_id": "aa225c16-af6e-4ab4-9150-456fd472e2d7"
}
Response samples 
application/json
{
  • "id": "6414fa11-289f-4aa0-b67e-dcef072af92e",
  • "server_id": "5a3af768-063f-4a12-a056-8ef24e555556",
  • "server_uid": "9001",
  • "service_user_id": "aa225c16-af6e-4ab4-9150-456fd472e2d7"
}
Delete a Service from a Server
Admin roles: 
  • access_admin
Deletes a Service from a Server. This prevents Service Users from accessing the Server with the deleted Service.


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


 
project_name
required
string
The Project name


 
server_id
required
string
The UUID of the Server


 
service_id
required
string
The UUID of the Service


 
Responses 
204
No Content


delete/v1/teams/{team_name}/projects/{project_name}/servers/{server_id}/services/{service_id}
Request samples 
List all Services for a Team
Admin roles: 
  • access_user
  • access_admin
  • reporting_user
Lists all Services available for your Team


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


 
Responses 
200
OK


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


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


 
service_id
required
string
The UUID of the Service


 
Responses 
200
OK


get/v1/teams/{team_name}/services/{service_id}
Request samples 
Response samples 
application/json
{
  • "id": "6414fa11-289f-4aa0-b67e-dcef072af92e",
  • "server_id": "5a3af768-063f-4a12-a056-8ef24e555556",
  • "server_uid": "9001",
  • "service_user_id": "aa225c16-af6e-4ab4-9150-456fd472e2d7"
}
Delete a Service from a Team
Admin roles: 
  • access_admin
Deletes a Service from your Team. This prevents Service Users from accessing the associated Server with the deleted Service.


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


 
service_id
required
string
The UUID of the Service


 
Responses 
204
No Content


delete/v1/teams/{team_name}/services/{service_id}
Request samples