1. Docs
  2. API Reference
  3. List the organizations an end-user connection is bound to

List the organizations an end-user connection is bound to

GET/portal/v1/accounts/{accountSlug}/sso/connections/{id}/organizations

Lists one page of the organizations this end_user connection is bound to across the Account's Environments, oldest binding first unless sorted (sort_by organization or created), each with the organization's Environment and the membership role a just-in-time login receives. Searches organization names and slugs with q; verified_domain=false narrows to the bindings whose organization has no verified domain yet (they route no sign-in and block activation). Returns 404 when the connection is not found or is not end_user-scope.

Authentication

Bearer TokenAuthorization

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

Requires capability sso.viewSecurity

View SSO connections, domains, and directory sync. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

idstring Required

Query Parameters

pagenumber Optional

Page number (1-based)

min 1

takenumber Optional

Items per page (1-100, default 20)

range 1–100

qstring Optional

Search organization names and slugs

max length 200

sort_byenum Optional

Sort column. Defaults to `created`, oldest binding first.

one of "organization" · "created"

orderenum Optional

Sort direction

one of "asc" · "desc"

verified_domainboolean Optional

When false, only bindings whose organization has no verified domain: the ones that route no sign-in and block activating the connection. When true, only those with one. Omit to list all.

Responses

application/json

  • itemsSsoConnectionOrganizationResponseDto[]*
  • paginationPageMetaDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Pagination

This endpoint returns a paginated collection. Use the query parameters below to page through results.

pagenumber

Page number (1-indexed). Defaults to 1.

takenumber

Items per page (1 to 100). Defaults to 20.

Each response includes an items array alongside a pagination object with item_count, page_count, has_previous_page, and has_next_page fields.

Returned object

SsoConnectionOrganizationResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/sso/connections/value/organizations?page=0&take=0&q=value&sort_by=organization&order=asc&verified_domain=false" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "organization_node_id": "string",
      "organization_node": {
        "id": "string",
        "name": "string",
        "slug": "string",
        "environment_id": "string"
      },
      "verified_domains": [
        "string"
      ],
      "sso_connection_id": "string",
      "default_role_id": "string",
      "default_role": {
        "id": "string",
        "name": "string"
      },
      "created_at": "2026-04-20T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 0,
    "take": 0,
    "item_count": 0,
    "page_count": 0,
    "has_previous_page": false,
    "has_next_page": false
  }
}
 Related endpoints
GETList SSO connections
POSTCreate an SSO connection
GETGet an SSO connection
PATCHUpdate an SSO connection
DELETEDelete an SSO connection
POSTActivate an SSO connection
POSTDisable an SSO connection
GETList OAuth-client links for an end-user connection
POSTLink an OAuth client to an end-user connection
PATCHUpdate an OAuth-client link
DELETEUnlink an OAuth client from a connection
GETList Environment bindings for an end-user connection
POSTBind an end-user connection to an Environment
PATCHUpdate an Environment binding
DELETEUnbind an end-user connection from an Environment
POSTStart a test sign-in
GETRead a test sign-in
GETList a connection's recent login attempts
GETList an OAuth client's SSO connection links
GETList Environments reachable by SSO
GETList SSO domain claims
POSTClaim a domain for admin SSO
POSTVerify a claimed domain
DELETERemove a domain claim
 Was this page helpful?

Tell us how we can improve this guide.

Canopy