ServiceAccounts REST API

Service Accounts REST API documentation and interactive testing.

PreviousService Account NextAccess Logging

Last updated 24 days ago

Was this helpful?

Query Service Accounts

get

This operation supports Elastic Search Query DSL query format

Authorizations

Query parameters

querystringoptional

Elastic Search Query DSL for querying service Accounts.

Example: { "query": { "match_all": {} } }

fromintegeroptional

Defines the starting record number for retrieval.

sizeintegeroptional

Defines the number of records to retrieve.

Header parameters

X-ObjectsGrid-AccessPointstring · enumrequired

EU or US depending on where your Organization Account is located

Available options:

X-ObjectsGrid-RestApiVersionstringoptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringoptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses

application/json

get

curl -L \
  --url 'https://apis.objectsgrid.com/serviceaccounts' \
  --header 'Authorization: Bearer Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU'

200

400

401

427

500

[]

Successfully listed the service accounts

Retrieve a Service Account

get

Authorizations

Path parameters

idstringrequired

ID of the service account to retrieve

Header parameters

X-ObjectsGrid-AccessPointstring · enumrequired

EU or US depending on where your Organization Account is located

Available options:

X-ObjectsGrid-RestApiVersionstringoptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringoptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses

application/json

get

curl -L \
  --url 'https://apis.objectsgrid.com/serviceaccounts/{id}' \
  --header 'Authorization: Bearer Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU'

200

400

401

404

427

500

{
  "id": "text",
  "secret": "text",
  "description": "text",
  "type": "secret",
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-04-11T03:44:28.237Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T03:44:28.237Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully retrieved the service account

Delete a Service Account

delete

Deletes the Service Account

Authorizations

Path parameters

idstringrequired

ID of the service account to delete

Header parameters

X-ObjectsGrid-AccessPointstring · enumrequired

EU or US depending on where your Organization Account is located

Available options:

X-ObjectsGrid-RestApiVersionstringoptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringoptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses

application/json

delete

curl -L \
  --request DELETE \
  --url 'https://apis.objectsgrid.com/serviceaccounts/{id}' \
  --header 'Authorization: Bearer Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU'

200

400

401

404

427

500

No Content

Successfully deleted the service account

Create a Service Account

post

Authorizations

Header parameters

X-ObjectsGrid-AccessPointstring · enumrequired

EU or US depending on where your Organization Account is located

Available options:

X-ObjectsGrid-RestApiVersionstringoptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringoptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body

idstringoptional

The ServiceAccount's ID, generated

secretstringoptional

The ServiceAccount's secret, generated

descriptionstringrequired

typestring · enumrequired

A Service Account of type 'secret' is used for machine-to-machine (M2M) communication. When created, a corresponding Service Account secret will be generated.
A Service Account of type 'public' is used for anonymous access, and no secret will be generated.

Available options:

disabledbooleanoptional

true indicates the Service Account is disabled and cannot execute any API operations

tagsobject[]required

metaobjectoptional

Responses

application/json

post

curl -L \
  --request POST \
  --url 'https://apis.objectsgrid.com/serviceaccounts' \
  --header 'Authorization: Bearer Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "secret": "text",
    "description": "text",
    "type": "secret",
    "disabled": true,
    "tags": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "meta": {
      "objectVersion": 1,
      "objectType": "text",
      "namespace": "text",
      "createdAt": "2025-04-11T03:44:28.237Z",
      "createdBy": "text",
      "lastUpdatedAt": "2025-04-11T03:44:28.237Z",
      "lastUpdatedBy": "text",
      "lastUpdateCorrelationID": "text"
    }
  }'

201

400

401

409

427

500

{
  "id": "text",
  "secret": "text",
  "description": "text",
  "type": "secret",
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-04-11T03:44:28.237Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T03:44:28.237Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully created the service account

Update a Service Account

put

Authorizations

Path parameters

idstringrequired

ID of the service account to update

Header parameters

X-ObjectsGrid-AccessPointstring · enumrequired

EU or US depending on where your Organization Account is located

Available options:

X-ObjectsGrid-RestApiVersionstringoptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringoptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body

idstringoptional

The ServiceAccount's ID, generated

secretstringoptional

The ServiceAccount's secret, generated

descriptionstringrequired

typestring · enumrequired

A Service Account of type 'secret' is used for machine-to-machine (M2M) communication. When created, a corresponding Service Account secret will be generated.
A Service Account of type 'public' is used for anonymous access, and no secret will be generated.

Available options:

disabledbooleanoptional

true indicates the Service Account is disabled and cannot execute any API operations

tagsobject[]required

metaobjectoptional

Responses

application/json

put

curl -L \
  --request PUT \
  --url 'https://apis.objectsgrid.com/serviceaccounts/{id}' \
  --header 'Authorization: Bearer Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "secret": "text",
    "description": "text",
    "type": "secret",
    "disabled": true,
    "tags": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "meta": {
      "objectVersion": 1,
      "objectType": "text",
      "namespace": "text",
      "createdAt": "2025-04-11T03:44:28.237Z",
      "createdBy": "text",
      "lastUpdatedAt": "2025-04-11T03:44:28.237Z",
      "lastUpdatedBy": "text",
      "lastUpdateCorrelationID": "text"
    }
  }'

200

400

401

404

427

500

{
  "id": "text",
  "secret": "text",
  "description": "text",
  "type": "secret",
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-04-11T03:44:28.237Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T03:44:28.237Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully updated the service account

Query Service Accounts

Retrieve a Service Account

Delete a Service Account

Create a Service Account

Show child attributes

Show child attributes

Update a Service Account

Show child attributes

Show child attributes