Update an identity provider connection
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the identity provider connection
Name of the identity provider connection, shown to organization admins.
Identity provider behind the connection.
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.
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
Team to add members to, or null to add them to none.
Email domains the provider signs people in for. Each one must be an email domain of the organization. Only emails on a verified domain in this list can sign in through the provider.
Connection updated
A connection to an identity provider, which signs organization members in with SAML and provisions them with SCIM.
The object type, which is always "idp-connection"
Unique identifier of the connection
Name of the identity provider connection, shown to organization admins.
Identity provider behind the connection.
Status of the connection.
pending: GitBook hasn't seen the identity provider use the connection yet.ready: A member signed in with SAML through the connection, or the identity provider sent an authenticated SCIM request.
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.
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
Whether people join the team of the verified email domain they signed in with, instead of defaultTeam.
Date of creation
Date of the last update
Bad Request
Not Found
PATCH /v1/orgs/{organizationId}/idp-connections/{idpConnectionId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 195
{
"label": "text",
"provider": "okta",
"defaultRole": "admin",
"defaultTeam": "text",
"defaultTeamFromDomain": true,
"ssoURL": "https://example.com",
"entityID": "text",
"certificate": "text",
"domains": [
"text"
]
}{
"object": "idp-connection",
"id": "text",
"label": "text",
"provider": "okta",
"status": "pending",
"defaultRole": "admin",
"defaultTeam": {
"object": "team",
"id": "text",
"title": "text",
"members": 1,
"spaces": 1,
"createdAt": "2026-01-01T00:00:00.000Z",
"permissions": {
"admin": true,
"view": true
}
},
"defaultTeamFromDomain": true,
"saml": {
"ssoURL": "https://example.com",
"entityID": "text",
"certificate": "text",
"domains": [
{
"domain": "text",
"status": "verified"
}
],
"service": {
"acsURL": "https://example.com",
"startURL": "https://example.com",
"entityID": "text"
},
"lastUsedAt": "2026-01-01T00:00:00.000Z"
},
"scim": {
"baseURL": "https://example.com",
"tokenHint": "text",
"tokenCreatedAt": "2026-01-01T00:00:00.000Z",
"lastUsedAt": "2026-01-01T00:00:00.000Z"
},
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"urls": {
"location": "https://example.com"
}
}Last updated
Was this helpful?