UserAccounts REST API

User Accounts REST API documentation and interactive testing.

PreviousUser Account NextService Account

Last updated 25 days ago

Was this helpful?

Query User Accounts

get

This operation supports three valid combinations of input parameters:

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

Available options:

Responses

application/json

get

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

200

400

401

427

500

[
  {
    "id": "text",
    "countryCode": "text",
    "city": "text",
    "postalCode": 1,
    "disabled": true,
    "tags": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "meta": {
      "objectVersion": 1,
      "objectType": "text",
      "namespace": "text",
      "createdAt": "2025-04-11T03:34:22.180Z",
      "createdBy": "text",
      "lastUpdatedAt": "2025-04-11T03:34:22.180Z",
      "lastUpdatedBy": "text",
      "lastUpdateCorrelationID": "text"
    }
  }
]

Successfully listed the user accounts

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

Available options:

Responses

application/json

get

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

200

400

401

404

427

500

{
  "id": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-04-11T03:34:22.180Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T03:34:22.180Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully retrieved the user account

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

Available options:

Responses

application/json

delete

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

200

400

401

404

427

500

{
  "id": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-04-11T03:34:22.180Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T03:34:22.180Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully deleted the user account

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

Available options:

Responses

application/json

get

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

200

400

401

404

427

500

{
  "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-04-11T03:34:22.180Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T03:34:22.180Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully retrieved the user private information

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

Available options:

Responses

application/json

delete

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

200

400

401

404

427

500

{
  "id": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-04-11T03:34:22.180Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T03:34:22.180Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully deleted the user account

Create User Account

post

Authorizations

Header parameters

X-ObjectsGrid-AccessPointstring · enumrequired

EU or US depending on where your Organization Account is located

Available options:

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

metaobjectoptional

Responses

application/json

post

curl -L \
  --request POST \
  --url 'https://apis.objectsgrid.com/useraccounts' \
  --header 'Authorization: Bearer Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU' \
  --header 'Content-Type: application/json' \
  --data '{
    "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-04-11T03:34:22.180Z",
      "createdBy": "text",
      "lastUpdatedAt": "2025-04-11T03:34:22.180Z",
      "lastUpdatedBy": "text",
      "lastUpdateCorrelationID": "text"
    }
  }'

201

400

401

409

427

500

{
  "id": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-04-11T03:34:22.180Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T03:34:22.180Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully created the user account

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

Available options:

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

tagsobject[]required

metaobjectoptional

Responses

application/json

put

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

200

400

401

404

427

500

{
  "id": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-04-11T03:34:22.180Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T03:34:22.180Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully updated the user account

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

Available options:

Body

idstringoptional

emailstringoptional

A valid email address

givenNamestringoptional

middleNamestringoptional

familyNamestringoptional

addressstringoptional

countryCodestringoptional

Two characters country code, ISO-3166 compliant

citystringoptional

postalCodeintegeroptional

phonestringoptional

tagsobject[]optional

metaobjectoptional

Responses

application/json

put

curl -L \
  --request PUT \
  --url 'https://apis.objectsgrid.com/userprivateinformation/{id}' \
  --header 'Authorization: Bearer Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU' \
  --header 'Content-Type: application/json' \
  --data '{
    "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-04-11T03:34:22.180Z",
      "createdBy": "text",
      "lastUpdatedAt": "2025-04-11T03:34:22.180Z",
      "lastUpdatedBy": "text",
      "lastUpdateCorrelationID": "text"
    }
  }'

200

400

401

404

427

500

{
  "id": "text",
  "countryCode": "text",
  "city": "text",
  "postalCode": 1,
  "disabled": true,
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-04-11T03:34:22.180Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T03:34:22.180Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully updated the user private information

Query User Accounts

Retrieve User Account

Delete User Account

Retrieve User Private Information

Delete User Private Information

Create User Account

Show child attributes

Update User Account

Show child attributes

Show child attributes

Update User Private Information

Show child attributes

Show child attributes