1. Docs
  2. API Reference
  3. OrganizationSsoArrivalRoleDto

OrganizationSsoArrivalRoleDto

Example

JSON
{
  "id": "string",
  "name": "string",
  "description": "string",
  "administers_organization": false,
  "is_default": false
}

Properties

5 properties 4 required

id string Required
name string Required
description string Optional
nullable
administers_organization boolean Required

The role carries `canopy:organization.manage`: everyone arriving with it administers the organization.

is_default boolean Required

The role to preselect: the directory list's arrival role, or the default of the Environment's identity-provider arrival roles. At most one entry.

Was this page helpful?

Tell us how we can improve this guide.