> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/developers/gitbook-api/api-reference/sso/list-identity-provider-connections.md).

# List identity provider connections

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"sso","description":"Tie GitBook into your corporate identity management and authentication providers (like SAML or OAuth). This centralizes user authentication and improves security.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"Subdomain\" grouped=\"false\" %}\n    The Subdomain object\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user-internal":[]}],"components":{"securitySchemes":{"user-internal":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"$ref":"#/components/schemas/EntityId"}}},"schemas":{"EntityId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"A unique entity identifier"},"List":{"type":"object","properties":{"next":{"type":"object","properties":{"page":{"type":"string","description":"Unique identifier to query the next results page"}},"required":["page"]},"count":{"type":"number","description":"Total count of objects in the list"}}},"OrganizationIdPConnection":{"type":"object","description":"A connection to an identity provider, which signs organization members in with SAML and provisions them with SCIM.\n","properties":{"object":{"type":"string","description":"The object type, which is always \"idp-connection\"","enum":["idp-connection"]},"id":{"type":"string","description":"Unique identifier of the connection"},"label":{"$ref":"#/components/schemas/IdPConnectionLabel"},"provider":{"$ref":"#/components/schemas/IdPConnectionProvider"},"status":{"$ref":"#/components/schemas/IdPConnectionStatus"},"defaultRole":{"$ref":"#/components/schemas/SAMLProviderDefaultRole"},"defaultTeam":{"$ref":"#/components/schemas/OrganizationTeam"},"defaultTeamFromDomain":{"type":"boolean","description":"Whether people join the team of the verified email domain they signed in with, instead of `defaultTeam`.\n"},"saml":{"type":"object","description":"SAML sign-in through the connection.","properties":{"ssoURL":{"description":"The identity provider's single sign-on URL. Absent until it is set.","$ref":"#/components/schemas/URL"},"entityID":{"description":"Entity ID of the identity provider. Absent until it is set.","$ref":"#/components/schemas/SAMLProviderEntityID"},"certificate":{"description":"X.509 certificate of the identity provider. Absent until it is set.","$ref":"#/components/schemas/SAMLProviderCertificate"},"domains":{"type":"array","description":"Email domains the connection signs people in for. Absent on connections created before domains existed, which accept any email.\n","items":{"$ref":"#/components/schemas/SAMLProviderDomain"}},"service":{"type":"object","description":"Service provider values to configure in the identity provider.","properties":{"acsURL":{"type":"string","description":"Assertion Consumer Service (ACS) URL","format":"uri"},"startURL":{"type":"string","description":"Start URL for the identity provider","format":"uri"},"entityID":{"$ref":"#/components/schemas/SAMLProviderEntityID"}},"required":["acsURL","startURL","entityID"]},"lastUsedAt":{"description":"Date of the last successful sign-in through the connection","$ref":"#/components/schemas/Timestamp"}},"required":["service"]},"scim":{"type":"object","description":"SCIM provisioning through the connection. Absent on connections created before SCIM, until their SCIM token is created.\n","properties":{"baseURL":{"description":"SCIM base URL to configure in the identity provider","$ref":"#/components/schemas/URL"},"tokenHint":{"type":"string","description":"Last characters of the current token, to identify it"},"tokenCreatedAt":{"description":"Date the current token was created","$ref":"#/components/schemas/Timestamp"},"lastUsedAt":{"description":"Date of the last request authenticated with the token","$ref":"#/components/schemas/Timestamp"}},"required":["baseURL","tokenHint","tokenCreatedAt"]},"createdAt":{"description":"Date of creation","$ref":"#/components/schemas/Timestamp"},"updatedAt":{"description":"Date of the last update","$ref":"#/components/schemas/Timestamp"},"urls":{"type":"object","description":"URLs associated with the object","properties":{"location":{"description":"URL of the connection in the API","$ref":"#/components/schemas/URL"}},"required":["location"]}},"required":["object","id","label","provider","status","defaultRole","defaultTeamFromDomain","saml","createdAt","updatedAt","urls"]},"IdPConnectionLabel":{"type":"string","description":"Name of the identity provider connection, shown to organization admins.","minLength":1,"maxLength":100},"IdPConnectionProvider":{"type":"string","description":"Identity provider behind the connection.","enum":["okta","entra","generic"]},"IdPConnectionStatus":{"type":"string","description":"Status of the connection.\n- `pending`: GitBook hasn't seen the identity provider use the connection yet.\n- `ready`: A member signed in with SAML through the connection, or the identity provider sent an authenticated SCIM request.\n","enum":["pending","ready"]},"SAMLProviderDefaultRole":{"description":"Role given to people on their first sign-in through the provider. null adds them as guests, \"default\" uses the organization's default role, and \"domain\" uses the role of the verified email domain they signed in with.\n","oneOf":[{"$ref":"#/components/schemas/MemberRole"},{"type":"null"},{"type":"string","enum":["default","domain"]}]},"MemberRole":{"type":"string","description":"\"The role of a member in an organization.\n\"admin\": Can administrate the content: create, delete spaces, ...\n\"create\": Can create content.\n\"review\": Can review content.\n\"edit\": Can edit the content (live or change requests).\n\"comment\": Can access the content and its discussions.\n\"read\": Can access the content, but cannot update it in any way.\n","enum":["admin","create","edit","review","comment","read"]},"OrganizationTeam":{"type":"object","properties":{"object":{"type":"string","description":"Type of Object, always equals to \"team\"","enum":["team"]},"id":{"type":"string","description":"Unique identifier for the team."},"title":{"$ref":"#/components/schemas/OrganizationTeamTitle"},"members":{"type":"integer","description":"Count of members in this team."},"spaces":{"type":"number","description":"Count of spaces this team has access to."},"createdAt":{"description":"Date at which the team was created.","$ref":"#/components/schemas/Timestamp"},"permissions":{"type":"object","description":"The set of permissions for the team","properties":{"admin":{"type":"boolean","description":"Can the user manage the team"},"view":{"type":"boolean","description":"Can the user view the team and list its members"}},"required":["admin","view"]}},"required":["object","id","title","members","spaces","createdAt","permissions"]},"OrganizationTeamTitle":{"type":"string","description":"Title of the team","minLength":1,"maxLength":64},"Timestamp":{"type":"string","format":"date-time"},"URL":{"type":"string","format":"uri","maxLength":2048},"SAMLProviderEntityID":{"type":"string","maxLength":1024},"SAMLProviderCertificate":{"type":"string","maxLength":10000},"SAMLProviderDomain":{"type":"object","description":"An email domain of a SAML provider, with its verification state in the organization.","properties":{"domain":{"type":"string"},"status":{"$ref":"#/components/schemas/SAMLProviderDomainStatus"}},"required":["domain","status"]},"SAMLProviderDomainStatus":{"type":"string","description":"State of a SAML provider's email domain in the organization.\n- `verified`: People with an email on this domain can sign in through the provider.\n- `pending`, `error`, `legacy`: The domain isn't verified yet, so it doesn't let anyone sign in.\n- `removed`: The organization no longer has this domain.\n","enum":["verified","pending","error","legacy","removed"]}},"responses":{"NotFoundError":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","properties":{"code":{"type":"integer","format":"int32","enum":[404]},"message":{"type":"string"}},"required":["code","message"]}}}}}}}},"paths":{"/orgs/{organizationId}/idp-connections":{"get":{"operationId":"listOrganizationIdPConnections","summary":"List identity provider connections","tags":["sso"],"parameters":[{"$ref":"#/components/parameters/organizationId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/List"},{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationIdPConnection"}}}}]}}}},"404":{"$ref":"#/components/responses/NotFoundError"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gitbook.com/docs/developers/gitbook-api/api-reference/sso/list-identity-provider-connections.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
