1. Docs
  2. API Reference
  3. List the roles the organization's SSO sign-ins may arrive with

List the roles the organization's SSO sign-ins may arrive with

GET/api/v1/organizations/{id}/sso-connection/arrival-roles

The roles a sign-in through the organization's connection may join with, for choosing its default_role_id. When the developer has set the organization's directory grantable roles, the list is those roles and is_default marks the arrival role among them; otherwise the Environment's identity-provider arrival roles (idp_arrival_roles in its auth settings), which every organization without a list of its own inherits; with neither, the Environment's active custom roles with nothing marked. administers_organization marks a role carrying canopy:organization.manage: everyone arriving with it administers the organization. An organization administrator (identity token) may only bind a role from this list; the developer's key is not bound by it. Requires hierarchy.view or canopy:organization.manage at the organization. The response is an unpaginated { items } array.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Path Parameters

idstring Required

Responses

application/json

  • itemsOrganizationSsoArrivalRoleDto[]*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

OrganizationSsoArrivalRoleDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/organizations/value/sso-connection/arrival-roles" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "administers_organization": false,
      "is_default": false
    }
  ]
}
 Related endpoints
GETWhat the caller administers in an organization
GETList the organization's tree as the caller sees it
GETList who holds a role at a node in the organization
GETSummarize who holds a role at a node in the organization
GETList the roles the caller may grant at a node
GETList the organization's members, for granting a role at a node
POSTGrant a role at a node beneath the organization
PATCHChange a grant in the organization
DELETETake a grant in the organization away
GETList organizations
POSTCreate an organization
DELETEDelete every organization
GETGet an organization
PATCHUpdate an organization
DELETEDelete an organization
GETGet an organization's authentication policy
PATCHUpdate an organization's authentication policy
POSTRegenerate the organization's SSO recovery codes
POSTStart a test sign-in on the organization's connection
GETRead the organization's test sign-in
GETList the organization's domain claims
POSTClaim a domain for the organization
POSTVerify one of the organization's domains
DELETERemove one of the organization's domain claims
GETList an organization's SSO connections
POSTBind an SSO connection to an organization
DELETEUnbind an SSO connection from an organization
GETList an organization's members
POSTAdd a member to an organization
DELETERemove a member from an organization
POSTReset a member's multi-factor authentication
GETList an organization's invitations
POSTInvite a member into an organization
GETList the roles an organization may assign
DELETERevoke an organization invitation
GETGet an organization's SSO connection
POSTSet up an organization's SSO connection
PATCHChange an organization's SSO connection
DELETERemove an organization's SSO connection
POSTActivate an organization's SSO connection
POSTDisable an organization's SSO connection
POSTImport the identity provider's SAML metadata
GETList the connection's recent sign-ins
GETGet the service-provider values for an organization's SSO connection
GETGet an organization's directory connection
POSTCreate an organization's directory connection
DELETERemove an organization's directory connection
GETList an organization's directory-sync tokens
POSTMint a directory-sync token for an organization
POSTReplace a directory-sync token without an outage
DELETERevoke a directory-sync token
GETRecent directory-sync activity for an organization
GETList the roles an organization's directory may grant
PUTReplace the roles an organization's directory may grant
GETList the groups an organization's provider has pushed
PUTMap a pushed group to one of the available roles
DELETEClear a pushed group's role mapping
 Was this page helpful?

Tell us how we can improve this guide.

Canopy