Clients

The /Clients resource collection represents all client accounts created in the Orchestrator REST API. For more information on working with client accounts, see Working With Clients.

Create Client

The HTTP POST request to the /Clients endpoint creates a new client in the Orchestrator REST API.

SecurityuserAuth or clientAuth

Responses

200

401

Unauthorized request. The authorization header has been expected but not found (or found but expired).

500

Internal server error.

post/api/v7.21/Clients

Request samples

curl
Python
JavaScript
C#
Go

Response samples

{"client_id": "72225B81-3FC2-4116-9CDE-21270360B25C",
"client_secret": "AQAAANCMnd8BFdERjHoAwE/Cl+sBAAAAsneM13KrLkeVp65TEJUEVQQAAAACAAAAAAADZgAAwAAAABAAAACEixjCW8UWYZX2OzYCbgABAAAAAASAAACgAAAAEAAAABXNWdVlURqstg4xW/t6W35YAAAAnGNOH86gxQZkzhMRa9+Pjrq8grLCNjMrwGMxaGqgeBGGN1/kz+ajf2XdZMaiAkJE+lYNQFpsw6WhOrO2ufihNvzF9HtmnPAHWOVmfLxMIhosqU7x9Skh5BQAAAAnl1pwO6vJ6d48/K8F+x6Sl53icg=="
}

Get List of Clients

The HTTP GET request to the /Clients endpoint retrieves a list of all created clients in the Orchestrator REST API.

NOTE
A client can get only its own client ID.

SecurityuserAuth or clientAuth

Responses

200

401

Unauthorized request. The authorization header has been expected but not found (or found but expired).

500

Internal server error.

get/api/v7.21/Clients

Request samples

curl
Python
JavaScript
C#
Go

Response samples

["4F82B8C7-4019-416D-9692-3EAE94523BDC",
"55D17162-D691-433C-8758-152832C62AE3",
"A25A3685-D329-4FD7-864E-C5F3E9D9BAAB"
]

Delete Client

The HTTP DELETE request to the /Clients endpoint deletes a client with the specified client ID.

NOTE
A user can delete all related client accounts. A client can delete only his own client account.

SecurityuserAuth or clientAuth

Request

query Parameters

clientId

required

string

System ID assigned to a client.

Responses

204

No Content

401

Unauthorized request. The authorization header has been expected but not found (or found but expired).

500

Internal server error.

delete/api/v7.21/Clients

Request samples

curl
Python
JavaScript
C#
Go