Client

The client represents the authenticated application. See the applications guide for more details.

Client object

Here is an example client object:

{
  "object": "client",
  "name": "app",
  "concurrentJobsLimit": 100
}

WARNING

Each application is associated with a single valid secret key. Do not expose the secret anywhere, as it provides access to many endpoints on behalf of your app. Please regenerate the secret if you lose or compromise it – you can do so via the Automation Cloud Dashboard.

---

Retrieve a Client

Returns the corresponding client information.

Headers

Authorization

stringrequired

Basic authorization header, where credentials are the Base64 encoding of app secret and a blank password joined by a single colon.

Example: Authorization: Basic <credentials>

ContentType

stringrequired

Media type of the request.

Example: Content-Type: application/json

Query Parameters

sort

stringoptional

Sort client list by a parameter.

Default: sort=name

Enum: ["name","email","createdAt"]

Example: sort=name

Code sample

GET/client

curl -X GET 'https://api.automationcloud.net/client' \
    -H 'Authorization: Basic <credentials>' \
    -H 'Content-Type: application/json' \
    -G \
    -d 'sort=name' 

Success Responses

Status 200

{
  "object": "client",
  "name": "app",
  "concurrentJobsLimit": 100
}

Here is your Automation Cloud client object.