Skip to main content
API docs by Redocly

Service Accounts (0.0.20)

Download OpenAPI specification:Download

Service Accounts

Create new Service Account Deprecated

Create new service account

Authorizations:
ApplicationToken
Request Body schema: application/json
accountId
string
createdBy
string
dateCreated
integer <int64>
dateUpdated
integer <int64>
email
string <email>
id
integer <int64>
name
string
project
string
resourceId
string
updatedBy
string

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "createdBy": "string",
  • "dateCreated": 0,
  • "dateUpdated": 0,
  • "email": "user@example.com",
  • "id": 0,
  • "name": "string",
  • "project": "string",
  • "resourceId": "string",
  • "updatedBy": "string"
}

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "createdBy": "string",
  • "dateCreated": 0,
  • "dateUpdated": 0,
  • "email": "user@example.com",
  • "id": 0,
  • "name": "string",
  • "project": "string",
  • "resourceId": "string",
  • "updatedBy": "string"
}

Deletes a Service Account Deprecated

Deletes a Service Account

Authorizations:
ApplicationToken
path Parameters
accountId
required
string

Account Id of the service a account you want to performs an action on

Responses

Retrieve Service Account Deprecated

Retrieve service account

Authorizations:
ApplicationToken
path Parameters
emailOrAccountId
required
string

The email or Account ID of the service account you want to perform an action on

query Parameters
filter_by
string (FilterByEnum)
Default: "EMAIL"
Enum: "EMAIL" "SERVICE_ACCOUNT_ID"

Service Account field to match when obtaining ServiceAccount.

Responses

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "createdBy": "string",
  • "dateCreated": 0,
  • "dateUpdated": 0,
  • "email": "user@example.com",
  • "id": 0,
  • "name": "string",
  • "project": "string",
  • "resourceId": "string",
  • "updatedBy": "string"
}

Page of Service Account Deprecated

Retrieve service account by project Id

Authorizations:
ApplicationToken
path Parameters
projectId
required
string

Project Id that you want to perform an action on

query Parameters
resourceId
string
Default: ""

The resourceId of the project that you want to return

size
integer <int> [ 5 .. 100 ]
Default: 20

The number of items to return per page

page
integer <int> >= 0
Default: 0

The page number that you want to return

sort
Array of strings
Example: sort=name,name,asc,name,desc

The sort order that you want to return. You can specify one or more comma-separated sort keys, each followed by an optional sort direction of either asc (ascending) or desc (descending).

If you want to sort in descending order, append ,desc to the sort key; otherwise, the default is to sort in ascending order. If you want to sort in ascending order, you can optionally append ,asc.

Examples of valid sort query parameters include:

  • sort=name: Sort by name in ascending order
  • sort=name,desc: Sort by name in descending order
  • sort=name,desc,created,asc: Sort by name in descending order, then by created in ascending order
  • sort=name,desc&sort=created,asc: Sort by name in descending order, then by created in ascending order

Responses

Response samples

Content type
application/json
{
  • "contentType": "ServiceAccountPage"
}

Validate Service Account credentials Deprecated

Validate Service Account credentials

Authorizations:
ApplicationToken
query Parameters
authType
string (AuthenticationTypeEnum)
Enum: "privateKey" "apiToken"

Authenticate method for Service Account

Request Body schema: application/json
One of
email
string
keyID
integer <int64>
secret
string
signature
string

Responses

Request samples

Content type
application/json
Example
{
  • "email": "string",
  • "keyID": 0,
  • "secret": "string",
  • "signature": "string"
}

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "createdBy": "string",
  • "dateCreated": 0,
  • "dateUpdated": 0,
  • "email": "user@example.com",
  • "id": 0,
  • "name": "string",
  • "project": "string",
  • "resourceId": "string",
  • "updatedBy": "string"
}

Api Token

Create new Api Token Deprecated

Authorizations:
ApplicationToken
path Parameters
accountId
required
string

Account Id of the service a account you want to performs an action on

Responses

Response samples

Content type
application/json
{
  • "apiToken": "string",
  • "status": "ENABLED"
}

List Api Tokens with status Deprecated

Authorizations:
ApplicationToken
path Parameters
accountId
required
string

Account Id of the service a account you want to performs an action on

query Parameters
status
string (StatusEnum)
Default: "ENABLED"
Enum: "ENABLED" "DISABLED"

Status value. Possible values are ENABLED, DISABLED

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an Api Tokens with status Deprecated

Authorizations:
ApplicationToken
path Parameters
apiToken
required
string

The API Token that you want to perform an action on

query Parameters
status
required
string (StatusEnum)
Default: "ENABLED"
Enum: "ENABLED" "DISABLED"

Status value. Possible values are ENABLED, DISABLED

Responses

Response samples

Content type
application/json
{
  • "apiToken": "string",
  • "status": "ENABLED"
}

Private Key

Generate service account Key and return the Private key Deprecated

Generate service account Private Key

Authorizations:
ApplicationToken
path Parameters
accountId
required
string

Account Id of the service a account you want to performs an action on

Responses

Response samples

Content type
application/json
{
  • "identifier": "string",
  • "keyID": 0,
  • "privateKey": "string"
}

Update service account Key Deprecated

Update service account Key

Authorizations:
ApplicationToken
path Parameters
accountId
required
string

Account Id of the service a account you want to performs an action on

query Parameters
keyId
required
integer <int64>

Id of the Private Key that you want to perform an action on

status
required
string (StatusEnum)
Default: "ENABLED"
Enum: "ENABLED" "DISABLED"

Status value. Possible values are ENABLED, DISABLED

Responses

Response samples

Content type
application/json
{
  • "dateCreated": 0,
  • "dateUpdated": 0,
  • "generatedBy": "string",
  • "id": 0,
  • "keyID": 0,
  • "privateKeyFormat": "string",
  • "publicKey": "string",
  • "publicKeyFormat": "string",
  • "serviceAccount": "string",
  • "status": "ENABLED"
}

List service account Keys Deprecated

List service account Keys

Authorizations:
ApplicationToken
path Parameters
accountId
required
string

Account Id of the service a account you want to performs an action on

query Parameters
status
required
string (StatusEnum)
Default: "ENABLED"
Enum: "ENABLED" "DISABLED"

Status value. Possible values are ENABLED, DISABLED

Responses

Response samples

Content type
application/json
[
  • {
    }
]