ServiceAccounts REST API

Service Accounts REST API documentation and interactive testing.

For the OpenAPI Specification document use this link: https://apis.objectsgrid.com/serviceaccounts/contract


Create a Service Account

post
Authorizations
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
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.
Possible values:
disabledbooleanOptional

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

Responses
201
Successfully created the service account
application/json
post
POST /serviceaccounts HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "id": "text",
  "secret": "text",
  "description": "text",
  "type": "secret",
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-14T11:01:59.936Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-14T11:01:59.936Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
{
  "id": "text",
  "secret": "text",
  "description": "text",
  "type": "secret",
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-14T11:01:59.936Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-14T11:01:59.936Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

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

Possible values:
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
200
Successfully listed the service accounts
application/json
get
GET /serviceaccounts HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*
[]

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

Possible values:
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
200
Successfully retrieved the service account
application/json
get
GET /serviceaccounts/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*
{
  "id": "text",
  "secret": "text",
  "description": "text",
  "type": "secret",
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-14T11:01:59.936Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-14T11:01:59.936Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

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

Possible values:
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.
Possible values:
disabledbooleanOptional

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

Responses
200
Successfully updated the service account
application/json
put
PUT /serviceaccounts/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "id": "text",
  "secret": "text",
  "description": "text",
  "type": "secret",
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-14T11:01:59.936Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-14T11:01:59.936Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
{
  "id": "text",
  "secret": "text",
  "description": "text",
  "type": "secret",
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-14T11:01:59.936Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-14T11:01:59.936Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

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

Possible values:
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
200
Successfully deleted the service account
delete
DELETE /serviceaccounts/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

No content

Last updated

Was this helpful?