Skip to content

DocuSign: Returns the list of identity providers for an organization

DocuSign admin.adminOrganizationGetIdentityProviders: arguments, response, policy and SDK examples.

← Admin operations · Get started

Operation docusign.admin_organization_getidentityproviders

Provider route: GET /Management/v2/organizations/{organizationId}/identity_providers. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["admin"]["adminOrganizationGetIdentityProviders"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.admin.adminOrganizationGetIdentityProviders(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.admin.admin_organization_get_identity_providers(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.organizationIdstringRequired within parentFormat: uuid

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Returns the list of identity providers for an organization — response body

Referenced models: Returns the list of identity providers for an organization — response body

Returns the list of identity providers for an organization — response body
FieldTypePresenceDescription and constraints
$objectRoot
identity_providersarrayOptional
identity_providers[]ModelEach itemExpand Returns the list of identity providers for an organization — response body — identity providers item

Referenced models: Returns the list of identity providers for an organization — response body — identity providers item

Returns the list of identity providers for an organization — response body — identity providers item
FieldTypePresenceDescription and constraints
$objectRootInformation about a single identity provider.
auto_provision_usersbooleanOptionalWhen **true,** users who use this identity provider are automatically provisioned.
friendly_namestringOptionalThe human-readable name of the identity provider.
idstringOptionalThe unique ID of the identity provider.
Format: uuid
linksarrayOptionalA list of useful URLs.
links[]ModelEach itemExpand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item
saml_20ModelOptionalExpand Returns the list of identity providers for an organization — response body — identity providers item saml 20
If `type` is `saml_20`, contains details about the SAML 2.0 response.
typestringOptionalThe type of the identity provider. One of:

- `none`
- `saml_20`
- `saml_11`
- `saml_10`
- `ws_federation`
- `open_id_connect`

Referenced models: Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item, Returns the list of identity providers for an organization — response body — identity providers item saml 20

Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item
FieldTypePresenceDescription and constraints
$objectRootA link to a useful URL.
hrefstringOptionalThe URL of the linked item.
relstringOptionalThe kind of linked item.
Returns the list of identity providers for an organization — response body — identity providers item saml 20
FieldTypePresenceDescription and constraints
$objectRootInformation about a SAML 2.0 identity provider.
attribute_mappingsarrayOptionalA list of attribute mappings.
attribute_mappings[]ModelEach itemExpand Returns the list of identity providers for an organization — response body — identity providers item saml 20 attribute mappings item
certificatesarrayOptionalA list of certificates responses.
certificates[]ModelEach itemExpand Returns the list of identity providers for an organization — response body — identity providers item saml 20 certificates item
issuerstringOptionalThe name of the certificate issuer.
settingsarrayOptionalA list of settings.
settings[]ModelEach itemExpand Returns the list of reserved domains for the organization — response body — reserved domains item settings item

Referenced models: Returns the list of identity providers for an organization — response body — identity providers item saml 20 certificates item, Returns the list of identity providers for an organization — response body — identity providers item saml 20 attribute mappings item, Returns the list of reserved domains for the organization — response body — reserved domains item settings item

Returns the list of identity providers for an organization — response body — identity providers item saml 20 certificates item
FieldTypePresenceDescription and constraints
$objectRootInformation about a single certificate.
expiration_datestringOptionalThe date when the certificate expires.
Format: date-time
idstringOptionalThe unique ID of the certificate.
Format: uuid
is_validbooleanOptionalWhen **true,** the certificate is valid.
Read only: true
issuerstringOptionalThe certificate issuer.
linksarrayOptionalA list of useful links.
links[]ModelEach itemExpand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item
thumbprintstringOptionalThe thumbprint of the certificate.

Referenced models: Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item

Returns the list of identity providers for an organization — response body — identity providers item saml 20 attribute mappings item
FieldTypePresenceDescription and constraints
$objectRootA single attribute mapping response.
required_attribute_friendly_namestringOptionalThe human-readable name of the attribute.
required_attribute_idJSONOptional
required_attribute_id (anyOf 1)integerAlternativeThe unique ID of the attribute.
Format: int32
required_attribute_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
required_attribute_namestringOptionalThe name of the attribute.
substitute_attribute_namestringOptionalThe name of the substitute attribute.
Returns the list of reserved domains for the organization — response body — reserved domains item settings item
FieldTypePresenceDescription and constraints
$objectRootA key/value list of settings.
keystringOptionalThe key of the setting.
typestringOptionalThe type of the setting. One of:

- `unknown`
- `guid`
- `text`
- `integer`
- `boolean`
- `datetime`
- `enumeration`
valueobjectOptionalThe value of the setting.

SDK function policy ID: docusign.admin_organization_getidentityproviders. Catalog operation: admin:Organization_GetIdentityProviders. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["identity_provider_read"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.