IAM Policies

IAM Policies

Get all IAM policies for an organization with pagination

get

Authorizations

apiAuth

Path parameters

organizationIdstringRequired

ID of the organization

Query parameters

pageintegerOptional

Page number for pagination

Default: 1

per_pageintegerOptional

Number of policies per page

Default: 15

Responses

200

List of IAM Policies

application/json

404

Organization not found

application/json

get

/api/organizations/{organizationId}/iam-policies

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/iam-policies HTTP/1.1
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Policy Name",
      "description": "Description of the policy",
      "type": "custom",
      "scope": "organization",
      "createdAt": "2024-10-07T17:17:02.138Z",
      "updatedAt": "2024-10-07T17:17:02.138Z",
      "definitions": [
        {
          "id": "definition-id-123",
          "effect": "allow",
          "action": "view",
          "resources": [
            {
              "id": "123548",
              "uri": "/api/v1/resource",
              "method": "GET",
              "version": "v1"
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "per_page": 1,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1
  }
}

Get all managed IAM policies

get

Authorizations

apiAuth

Query parameters

pageintegerOptional

Page number for pagination

Default: 1

per_pageintegerOptional

Number of policies per page for pagination

Default: 15

typestringOptional

Filter policies by type

Responses

200

List of IAM Policies

application/json

401

Unauthorized

403

Forbidden

get

/api/iam-policies

HTTPcURLJavaScriptPython

GET /api/iam-policies HTTP/1.1
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Policy Name",
      "description": "Description of the policy",
      "type": "custom",
      "scope": "organization",
      "createdAt": "2024-10-07T17:17:02.138Z",
      "updatedAt": "2024-10-07T17:17:02.138Z",
      "definitions": [
        {
          "id": "definition-id-123",
          "effect": "allow",
          "action": "view",
          "resources": [
            {
              "id": "123548",
              "uri": "/api/v1/resource",
              "method": "GET",
              "version": "v1"
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "total": 1,
    "per_page": 1,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1
  }
}

Create a custom IAM policy

post

Authorizations

apiAuth

Body

application/json

organization_idstringRequiredExample: org-123456

namestringRequiredExample: New Custom Policy

descriptionstringOptionalExample: A description for the custom policy

Responses

201

IAM Policy created successfully

application/json

400

Validation Error

application/json

404

Organization not found

application/json

post

/api/iam-policies

HTTPcURLJavaScriptPython

POST /api/iam-policies HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "organization_id": "org-123456",
  "name": "New Custom Policy",
  "description": "A description for the custom policy",
  "definitions": [
    {
      "effect": "allow",
      "action": "view",
      "resources": [
        "resource-id-123"
      ]
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Policy Name",
  "description": "Description of the policy",
  "type": "custom",
  "scope": "organization",
  "createdAt": "2024-10-07T17:17:02.138Z",
  "updatedAt": "2024-10-07T17:17:02.138Z",
  "definitions": [
    {
      "id": "definition-id-123",
      "effect": "allow",
      "action": "view",
      "resources": [
        {
          "id": "123548",
          "uri": "/api/v1/resource",
          "method": "GET",
          "version": "v1"
        }
      ]
    }
  ]
}

Get IAM policy by ID

get

Authorizations

apiAuth

Path parameters

idstringRequired

The ID of the IAM Policy

Responses

200

IAM Policy details

application/json

Response format for IAM policies

idstringOptionalExample: 123e4567-e89b-12d3-a456-426614174000

namestringOptionalExample: Policy Name

descriptionstringOptionalExample: Description of the policy

typestring · enumOptionalExample: customPossible values:

scopestringOptionalExample: organization

createdAtstring · date-timeOptionalExample: 2024-10-07T17:17:02.138Z

updatedAtstring · date-timeOptionalExample: 2024-10-07T17:17:02.138Z

404

Policy not found

get

/api/iam-policies/{id}

HTTPcURLJavaScriptPython

GET /api/iam-policies/{id} HTTP/1.1
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Policy Name",
  "description": "Description of the policy",
  "type": "custom",
  "scope": "organization",
  "createdAt": "2024-10-07T17:17:02.138Z",
  "updatedAt": "2024-10-07T17:17:02.138Z",
  "definitions": [
    {
      "id": "definition-id-123",
      "effect": "allow",
      "action": "view",
      "resources": [
        {
          "id": "123548",
          "uri": "/api/v1/resource",
          "method": "GET",
          "version": "v1"
        }
      ]
    }
  ]
}

Delete IAM policy

delete

Authorizations

apiAuth

Path parameters

idstringRequired

The ID of the IAM Policy

Responses

204

Policy deleted

404

Policy not found

delete

/api/iam-policies/{id}

HTTPcURLJavaScriptPython

DELETE /api/iam-policies/{id} HTTP/1.1
Accept: */*

No content

Update IAM policy

patch

Authorizations

apiAuth

Path parameters

idstringRequired

The ID of the IAM Policy

Body

application/json

namestringRequiredExample: Updated Policy Name

descriptionstringOptionalExample: Updated description

Responses

200

IAM Policy updated

application/json

Response format for IAM policies

idstringOptionalExample: 123e4567-e89b-12d3-a456-426614174000

namestringOptionalExample: Policy Name

descriptionstringOptionalExample: Description of the policy

typestring · enumOptionalExample: customPossible values:

scopestringOptionalExample: organization

createdAtstring · date-timeOptionalExample: 2024-10-07T17:17:02.138Z

updatedAtstring · date-timeOptionalExample: 2024-10-07T17:17:02.138Z

404

Policy not found

patch

/api/iam-policies/{id}

HTTPcURLJavaScriptPython

PATCH /api/iam-policies/{id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "name": "Updated Policy Name",
  "description": "Updated description"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Policy Name",
  "description": "Description of the policy",
  "type": "custom",
  "scope": "organization",
  "createdAt": "2024-10-07T17:17:02.138Z",
  "updatedAt": "2024-10-07T17:17:02.138Z",
  "definitions": [
    {
      "id": "definition-id-123",
      "effect": "allow",
      "action": "view",
      "resources": [
        {
          "id": "123548",
          "uri": "/api/v1/resource",
          "method": "GET",
          "version": "v1"
        }
      ]
    }
  ]
}