---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Organization roles"
description: "The `organization_roles` collection of Sylphx Auth: An Organization Role is an app-defined role of the environment's customer organizations: a key that memberships and invitations name, a display name (`meta.display_name`), and the app's…"
type: reference
product: organizations
summary: "An Organization Role is an app-defined role of the environment's customer organizations: a key that memberships and invitations name, a…"
updated: 2026-09-28
order: 900
---

An Organization Role is an app-defined role of the environment's customer organizations: a key that memberships and invitations name, a display name (`meta.display_name`), and the app's own permission strings. Roles are app data, not Access policy. `owner`, `admin`, and `member` are built in and need no Organization Role.

**Service** Sylphx Auth · **Resource type** `auth.sylphx.com/OrganizationRole` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/organization_roles/{organization_role}` · **Shape** `record`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/organization_roles/{organization_role}`; the final segment is the role key memberships name, for example `hr_manager`. |
| `uid` | `string` | `orl_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `permissions` | `string[]` | The app's permission strings `<resource>:<action>`, for example `invoices:read` or `org:payroll:approve`. |
| `auto_assign` | `bool` | Whether new members and invitations without roles get this role. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/organization_roles#get) | Gets an organization role. |
| `GET` | [`list`](/docs/api/organization_roles#list) | Lists organization roles. |
| `POST` | [`create`](/docs/api/organization_roles#create) | Creates an organization role. |
| `PATCH` | [`update`](/docs/api/organization_roles#update) | Updates an organization role. |
| `DELETE` | [`delete`](/docs/api/organization_roles#delete) | Deletes an organization role. |

## get

Gets an organization role.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/organization_roles/organization-role` · scope `auth:read` · effect `read` · [Request, response and examples](/docs/api/organization_roles/get)

## list

Lists organization roles.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/organization_roles` · scope `auth:read` · effect `read` · paginated · [Request, response and examples](/docs/api/organization_roles/list)

## create

Creates an organization role.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/organization_roles` · scope `auth:write` · effect `write` · [Request, response and examples](/docs/api/organization_roles/create)

## update

Updates an organization role.

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/organization_roles/organization-role` · scope `auth:write` · effect `write` · [Request, response and examples](/docs/api/organization_roles/update)

## delete

Deletes an organization role.

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/organization_roles/organization-role` · scope `auth:write` · effect `destructive` · [Request, response and examples](/docs/api/organization_roles/delete)