Members & roles

Organizations use role-based access control. Members are assigned roles, and roles contain scopes that grant specific permissions.

Members

Add member

POST /api/organizations/{id}/members

Parameter	Type	Required	Description
`email`	body	Yes	User’s email address
`role_id`	body	No	Role to assign (defaults to Member)

If the user doesn’t have a platform account, they receive an invitation email. Authentication: Organization member + members:invite scope.

Update member role

PUT /api/organizations/{id}/members/{userId}/role

Parameter	Type	Required	Description
`role_id`	body	Yes	New role ID

Authentication: Organization member + members:manage_roles scope.

Remove member

DELETE /api/organizations/{id}/members/{userId}

Members can remove themselves. Removing other members requires the members:remove scope. Authentication: Organization member + members:remove scope (or self-removal).

Roles

Every organization starts with a set of default roles, created with a description explaining what each one grants:

Role	Scopes
Admin	All scopes assigned — full organization access
Contributor	Publish, deploy, and share apps; no member or settings management
Member	No scopes — basic authenticated access

Non-personal organizations additionally get two service roles, which only service accounts may hold and only org:service-accounts holders may manage:

Role	Scopes
CI Provision Plan	None, by design — PR authors control what runs in PR context
CI Provision Apply	`infra:provision`

List roles

GET /api/organizations/{id}/roles

Returns all roles with their assigned scopes. Authentication: Organization member required.

Create role

POST /api/organizations/{id}/roles

Parameter	Type	Required	Description
`name`	body	Yes	Role display name
`description`	body	No	What the role is for. Trimmed; blank stores `null`
`scope_ids`	body	No	Array of scope IDs to assign

Authentication: Organization member + members:manage_roles scope.

Get role

GET /api/organizations/{id}/roles/{roleId}

Authentication: Organization member + members:manage_roles scope.

Update role

PUT /api/organizations/{id}/roles/{roleId}

Parameter	Type	Description
`name`	body	Updated role name
`description`	body	Updated description. Omit to leave unchanged; send `""` or `null` to clear
`scope_ids`	body	Updated scope assignments

Omitted fields are left as they are. Default roles’ descriptions can be edited like any other. Authentication: Organization member + members:manage_roles scope.

Delete role

DELETE /api/organizations/{id}/roles/{roleId}

Cannot delete the default Admin role. Members assigned to the deleted role should be reassigned first. Authentication: Organization member + members:manage_roles scope.

Scopes

List assignable scopes

GET /api/scopes

Returns scopes that can be assigned to organization roles. Authentication: User authentication required.

Get scope

GET /api/scopes/{id}

Authentication: User authentication required.

User invitations

Invite user

POST /api/users/invite

Parameter	Type	Required	Description
`email`	body	Yes	User’s email address
`orgId`	body	No	Organization to add the user to
`roleId`	body	No	Role to assign in the organization

If orgId is provided, the user is invited to the platform and added to the organization in one step. Authentication: Organization member + members:invite scope.

Platform Docs

Synthetiq Desktop

Synthetiq CLI

App Framework

Services Framework

Workflows Framework

Platform API

Deployments

Members & roles

Members

Add member

Update member role

Remove member

Roles

List roles

Create role

Get role

Update role

Delete role

Scopes

List assignable scopes

Get scope

User invitations

Invite user

​Members

​Add member

​Update member role

​Remove member

​Roles

​List roles

​Create role

​Get role

​Update role

​Delete role

​Scopes

​List assignable scopes

​Get scope

​User invitations

​Invite user

Members

Add member

Update member role

Remove member

Roles

List roles

Create role

Get role

Update role

Delete role

Scopes

List assignable scopes

Get scope

User invitations

Invite user