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
EU or US depending on where your Organization Account is located
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'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
The ServiceAccount's ID, generated
The ServiceAccount's secret, generated
- 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.
true indicates the Service Account is disabled and cannot execute any API operations
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-11T18:25:24.039Z",
"createdBy": "text",
"lastUpdatedAt": "2025-07-11T18:25:24.039Z",
"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-11T18:25:24.039Z",
"createdBy": "text",
"lastUpdatedAt": "2025-07-11T18:25:24.039Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}This operation supports Elastic Search Query DSL query format
Elastic Search Query DSL for querying service Accounts.
{ "query": { "match_all": {} } }Defines the starting record number for retrieval.
Defines the number of records to retrieve.
EU or US depending on where your Organization Account is located
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'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
GET /serviceaccounts HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*
[]ID of the service account to retrieve
EU or US depending on where your Organization Account is located
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'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
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-11T18:25:24.039Z",
"createdBy": "text",
"lastUpdatedAt": "2025-07-11T18:25:24.039Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}ID of the service account to update
EU or US depending on where your Organization Account is located
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'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
The ServiceAccount's ID, generated
The ServiceAccount's secret, generated
- 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.
true indicates the Service Account is disabled and cannot execute any API operations
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-11T18:25:24.039Z",
"createdBy": "text",
"lastUpdatedAt": "2025-07-11T18:25:24.039Z",
"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-11T18:25:24.039Z",
"createdBy": "text",
"lastUpdatedAt": "2025-07-11T18:25:24.039Z",
"lastUpdatedBy": "text",
"lastUpdateCorrelationID": "text"
}
}Deletes the Service Account
ID of the service account to delete
EU or US depending on where your Organization Account is located
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'
This header allows you to provide a Session ID to be traced through the request stack and returned in the response.
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?