Roles

A role is an access control resource that can be assigned to organization memberships, directory users, and SSO profiles.

Example Role

 const role = {
  object: 'role',
  id: 'role_01EHZNVPK3SFK441A1RGBFSHRT',
  name: 'Member',
  slug: 'member',
  description: 'Access to basic resources',
  permissions: ['posts:read', 'posts:write'],
  type: 'EnvironmentRole',
  createdAt: '2021-06-25T19:07:33.155Z',
  updatedAt: '2021-06-25T19:07:33.155Z',
};

`interface Role`

List roles for an organization

Get a list of all roles for the provided organization in priority order. Includes all environment and organization roles.

 import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS('sk_example_123456789');

const roles = await workos.organizations.listOrganizationRoles({
  organizationId: 'org_01EHZNVPK3SFK441A1RGBFSHRT',
});

console.log(roles.data);

Roles

`interface Role`

List roles for an organization

`organizations.listOrganizationRoles()`

`Returns` `object`

Roles

interface Role

object: "role"

id: string

name: string

slug: string

description: string | null

permissions: string[]

type: "EnvironmentRole" | "OrganizationRole"

createdAt: string

updatedAt: string

List roles for an organization

organizations.listOrganizationRoles()

Returns object

data: Role[]

`interface Role`

`organizations.listOrganizationRoles()`

`Returns` `object`