ObjectsGrid
  • Documentation
    • Core Concepts
    • Usage Guide
      • Quick Start
      • Authentication and Authorization
      • Access Control via ABAC
      • GraphQL API Examples
      • Login with Google app setup
      • Objects Schemas
    • OBJECTS GRID Objects
      • Generic Object
        • GenericObjects REST API
      • Enum Object
        • Enum Object REST API
      • ProductCatalog Object
      • ProductGroup Object
      • Product Object
      • Brand Object
        • Brands REST API
      • Language-Tagged String
      • Tags Object
      • Meta Object
    • Private Objects
      • Auth
        • Tokens REST API
      • ABAC Policy
        • ABACPolicies REST API
      • Organization Account
        • OrganizationAccounts REST API
      • User Account
        • UserAccounts REST API
      • Service Account
        • ServiceAccounts REST API
      • Access Logging
        • AccessLogEntries REST API
  • Support
    • Terms and Conditions
  • Blogs
    • Attribute Based Access Control
    • ABAC vs RBAC
Powered by GitBook
On this page

Was this helpful?

  1. Documentation
  2. Private Objects
  3. ABAC Policy

ABACPolicies REST API

ABAC Policy REST API documentation and interactive testing.

PreviousABAC PolicyNextOrganization Account

Last updated 2 months ago

Was this helpful?

For the document use this link:


OpenAPI Specification
https://apis.objectsgrid.com/abacpolicies/contract

Retrieve ABAC Policy

get
Authorizations
Path parameters
idstringRequired

ID of the ABAC Policy to retrieve. Presently there is only one per organization account, and its format is abac-policy--'orgAcctID', where orgAcctId is your Organization Account ID

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 ABAC Policy
application/json
400
Bad request
application/json
401
Unauthorized
application/json
404
Not Found
application/json
427
Too Many Requests
application/json
500
Internal server error
application/json
get
GET /abacpolicies/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*
{
  "id": "text",
  "policy": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T20:31:03.449Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T20:31:03.449Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
  • GETRetrieve ABAC Policy
  • PUTUpdate ABAC Policy

Update ABAC Policy

put
Authorizations
Path parameters
idstringRequired

ID of the ABAC Policy to retrieve. Presently there is only one per organization account, and its format is abac-policy--'orgAcctID', where orgAcctId is your Organization Account ID.

This id must match the id in the request body.

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 ABAC Policy's ID, generated

policystringRequired

The ABAC Policy written in Open Policy Agent (OPA) Language https://www.openpolicyagent.org/docs/latest/policy-language/

Responses
200
Successfully updated the ABAC Policy
application/json
400
Bad request
application/json
401
Unauthorized
application/json
404
Not Found
application/json
427
Too Many Requests
application/json
500
Internal server error
application/json
put
PUT /abacpolicies/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 290

{
  "id": "text",
  "policy": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T20:31:03.449Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T20:31:03.449Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}
{
  "id": "text",
  "policy": "text",
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T20:31:03.449Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T20:31:03.449Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}