Platform API reference

Platform API · Workspace-Roles

get/v1/workspaces/{workspace_slug}/roles/{role_id}Auth

Get a role + its permissions

Path parameters

workspace_slug*string

Slug of the workspace. Platform routes name the workspace by slug, positionally in the SDK (`platform.workspaces.retrieve("acme")`); the product APIs bind `workspace_id` instead.

role_id*string · uuid

Id of the role.

Response · 200

id*string · uuid

Id of the role.

name*string

Role name. System role names are `owner`/`admin`/`member`.

description*string

What the role is for, when set.

is_system*boolean

True for built-in system roles (owner/admin/member); false for custom roles.

policy*array

Effective IAM-style policy. When `policy_id` is set this is the bound managed policy; otherwise it is the inline policy column.

policy_id*string · uuid

Managed policy ID if the role is bound to one, else null.

Example

Request

GET https://api.platform-auth.productcraft.co/v1/workspaces/{workspace_slug}/roles/{role_id}
Authorization: Bearer YOUR_TOKEN

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "string",
  "description": "string",
  "is_system": false,
  "policy": [
    {
      "effect": "allow",
      "actions": [
        "social.read",
        "social.list"
      ],
      "resources": [
        "*"
      ]
    }
  ],
  "policy_id": "00000000-0000-0000-0000-000000000000"
}