/v1/workspaces/{workspace_slug}/roles/{role_id}AuthGet a role + its permissions
Path parameters
workspace_slug*stringSlug 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 · uuidId of the role.
Response · 200
id*string · uuidId of the role.
name*stringRole name. System role names are `owner`/`admin`/`member`.
description*stringWhat the role is for, when set.
is_system*booleanTrue for built-in system roles (owner/admin/member); false for custom roles.
policy*arrayEffective IAM-style policy. When `policy_id` is set this is the bound managed policy; otherwise it is the inline policy column.
policy_id*string · uuidManaged 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_TOKENimport { PlatformAuth } from "@productcraft/platform-auth";
// Reads PRODUCTCRAFT_API_KEY from the environment; administration
// calls take a person's session: { auth: { type: "bearer", token } }
const platform = new PlatformAuth();
const workspaceRole = await platform.workspaces.roles.retrieve("acme", "3f0c3c1e-8a2b-4c55-9d3f-0a1b2c3d4e5f");platform.workspaces.roles.retrieve(workspaceSlug, roleId, options?): PlatformAuth.WorkspaceRole
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"
}