Get a SAML provider by its ID
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the SAML provider
OK
Type of Object, always equals to "saml-provider"
Unique identifier for the provider.
Whether people join the team of the verified email domain they signed in with, instead of defaultTeam.
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.
Date at which the provider was created.
Status of the provider.
active: The provider is active and can be used to authenticate users.pending: The provider is pending and is not yet fully configured.
No matching provider found
GET /v1/orgs/{organizationId}/saml/{samlProviderId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"object": "saml-provider",
"id": "text",
"label": "text",
"ssoURL": "https://example.com",
"entityID": "text",
"certificate": "text",
"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,
"defaultRole": "admin",
"createdAt": "2026-01-01T00:00:00.000Z",
"status": "active",
"domains": [
{
"domain": "text",
"status": "verified"
}
],
"service": {
"acsURL": "https://example.com",
"startURL": "https://example.com",
"entityID": "text"
},
"urls": {
"location": "https://example.com"
}
}Last updated
Was this helpful?