IAM Roles

IAM Roles

List all roles in 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 roles per page

Default: 15

Responses

200

List of roles

application/json

404

Organization not found

get

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

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": "role-id",
      "name": "Admin Role",
      "description": "Description of the role",
      "organizationId": "organization-id",
      "type": "organization",
      "policies": [
        {
          "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 new role in an organization

post

Authorizations

apiAuth

Path parameters

organizationIdstringRequired

ID of the organization

Body

application/json

namestringRequired

Name of the role

descriptionstring | nullableOptional

Description of the role

policiesinteger[]Optional

List of policy IDs to attach to the role

Responses

201

Role created successfully

application/json

400

Validation error

404

Organization not found

post

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

HTTPcURLJavaScriptPython

POST /api/organizations/{organizationId}/iam-roles HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "name": "text",
  "description": "text",
  "policies": [
    1
  ]
}

{
  "id": "role-id",
  "name": "Admin Role",
  "description": "Description of the role",
  "organizationId": "organization-id",
  "type": "organization",
  "policies": [
    {
      "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 a role in an organization

delete

Authorizations

apiAuth

Path parameters

organizationIdintegerRequired

ID of the organization

roleIdintegerRequired

ID of the role to delete

Responses

204

Role deleted successfully

404

Organization or Role not found

delete

/api/organizations/{organizationId}/iam-roles/{roleId}

HTTPcURLJavaScriptPython

DELETE /api/organizations/{organizationId}/iam-roles/{roleId} HTTP/1.1
Host: 
Accept: */*

No content

Update an existing role

patch

Authorizations

apiAuth

Path parameters

organizationIdstringRequired

ID of the organization

roleIdintegerRequired

ID of the role

Body

application/json

namestringOptional

Name of the role

Example: Manager

descriptionstring | nullableOptional

Description of the role

Example: Role with management privileges

policiesinteger[]Optional

List of policy IDs to sync with the role

Responses

200

Role updated successfully

application/json

400

Validation error

404

Organization or Role not found

patch

/api/organizations/{organizationId}/iam-roles/{roleId}

HTTPcURLJavaScriptPython

PATCH /api/organizations/{organizationId}/iam-roles/{roleId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "name": "Manager",
  "description": "Role with management privileges",
  "policies": [
    1
  ]
}

{
  "id": "role-id",
  "name": "Admin Role",
  "description": "Description of the role",
  "organizationId": "organization-id",
  "type": "organization",
  "policies": [
    {
      "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"
            }
          ]
        }
      ]
    }
  ]
}