UserAccounts REST API

User Accounts REST API documentation and interactive testing.

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

Create User Account

post
Authorizations
Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
Body
emailstringRequired

A valid email address

givenNamestringOptional
middleNamestringOptional
familyNamestringOptional
addressstringOptional
countryCodestringOptional

Two characters country code, ISO-3166 compliant

citystringOptional
postalCodeintegerOptional
phonestringOptional
issstringRequired

The identity provider issuer. Can be found in the ID Token public claims

substringRequired

The identity provider subject. Can be found in the ID Token public claims

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

{
  "email": "text",
  "givenName": "text",
  "middleName": "text",
  "familyName": "text",
  "address": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "phone": "text",
  "iss": "text",
  "sub": "text",
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-15T12:25:02.119Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-15T12:25:02.119Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
{
  "id": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-15T12:25:02.119Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-15T12:25:02.119Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Query User Accounts

get

This operation supports three valid combinations of input parameters. You can use only one of the following combinations at the time:

  • query + from + size – Retrieves a paginated list of User Accounts based on a search query.
  • email – Retrieves a User Account by email.
  • iss + sub – Retrieves a User Account using the iss (Issuer) and sub (Subject) public claims from an ID Token.

Due to OpenAPI's specification current limitations, these combinations cannot be split into separate operations. As a result, they are documented here under a single operation. This may increase the risk of incorrect parameter usage and unexpected behavior.

Authorizations
Query parameters
querystringOptional

Elastic Search Query DSL for querying User Accounts. Used alongside the 'from' and 'size' parameters, and should not be combined with any others.

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

Defines the starting record number for retrieval. Used in conjunction with the 'query' and 'size' parameters, and should not be combined with any others.

sizeintegerOptional

Defines the number of records to retrieve. Used in conjunction with the 'query' and 'from' parameters, and should not be combined with any others.

emailstringOptional

Retrieves a User Account by email. This parameter must be used alone; do not include any other parameters.

issstringOptional

Retrieves a User Account using the 'iss' (Issuer) public claim attribute and the 'sub' (Subject) parameter from the ID Token issued by your Identity Provider (e.g., Google, Facebook, Okta). Must be used with the 'sub' parameter and no others.

substringOptional

Retrieves a User Account using the 'sub' (Subject) public claim attribute and the 'iss' (Issuer) parameter from the ID Token issued by your Identity Provider (e.g., Google, Facebook, Okta). Must be used with the 'iss' parameter and no others.

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
Responses
200
Successfully listed the user accounts
application/json
Responseone of
or
get
GET /useraccounts HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

[
  {
    "id": "text",
    "countryCode": "text",
    "city": "text",
    "postalCode": 1,
    "disabled": true,
    "tags": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "meta": {
      "objectVersion": 1,
      "objectType": "text",
      "namespace": "text",
      "createdAt": "2025-07-15T12:25:02.119Z",
      "createdBy": "text",
      "lastUpdatedAt": "2025-07-15T12:25:02.119Z",
      "lastUpdatedBy": "text",
      "lastUpdateCorrelationID": "text"
    }
  }
]

Retrieve User Account

get
Authorizations
Path parameters
idstringRequired

ID of the user account to retrieve

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
Responses
200
Successfully retrieved the user account
application/json
get
GET /useraccounts/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

{
  "id": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-15T12:25:02.119Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-15T12:25:02.119Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Update User Account

put
Authorizations
Path parameters
idstringRequired

ID of the user account to update

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
Body
idstringRequired

The User Account ID, generated

countryCodestringOptional

Two characters country code, ISO-3166 compliant

citystringOptional
postalCodeintegerOptional
disabledbooleanRequired

true means the User Account is disabled and cannot perform any API operations

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

{
  "id": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-15T12:25:02.119Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-15T12:25:02.119Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
{
  "id": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-15T12:25:02.119Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-15T12:25:02.119Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Delete User Account

delete

Deletes the User Account and related User Private Information. It cannot be undone; please use caution.

Authorizations
Path parameters
idstringRequired

ID of the user account to delete

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
Responses
200
Successfully deleted the user account
application/json
delete
DELETE /useraccounts/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

{
  "id": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-15T12:25:02.119Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-15T12:25:02.119Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Retrieve User Private Information

get
Authorizations
Path parameters
idstringRequired

ID of the user private information to retrieve

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
Responses
200
Successfully retrieved the user private information
application/json
get
GET /userprivateinformation/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

{
  "id": "text",
  "email": "text",
  "givenName": "text",
  "middleName": "text",
  "familyName": "text",
  "address": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "phone": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-15T12:25:02.119Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-15T12:25:02.119Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Update User Private Information

put
Authorizations
Path parameters
idstringRequired

ID of the user private information to update

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
Body
idstringOptional
emailstringOptional

A valid email address

givenNamestringOptional
middleNamestringOptional
familyNamestringOptional
addressstringOptional
countryCodestringOptional

Two characters country code, ISO-3166 compliant

citystringOptional
postalCodeintegerOptional
phonestringOptional
Responses
200
Successfully updated the user private information
application/json
put
PUT /userprivateinformation/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 430

{
  "id": "text",
  "email": "text",
  "givenName": "text",
  "middleName": "text",
  "familyName": "text",
  "address": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "phone": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-15T12:25:02.119Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-15T12:25:02.119Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
{
  "id": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-15T12:25:02.119Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-15T12:25:02.119Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Delete User Private Information

delete

Permanently deletes a user's private information while preserving the user account. Use this operation to comply with 'right to be forgotten' requests under regulations such as GDPR, CCPA, and similar privacy laws.

Authorizations
Path parameters
idstringRequired

ID of the user private information to delete

Header parameters
X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:
Responses
200
Successfully deleted the user account
application/json
delete
DELETE /userprivateinformation/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

{
  "id": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-07-15T12:25:02.119Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-07-15T12:25:02.119Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
PreviousUser AccountNextService Account

Last updated

Was this helpful?