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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.organizationId | string | Required within parent | Format: uuid |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Returns the list of identity providers for an organization — response body |
Referenced models: Returns the list of identity providers for an organization — response body
Schemas
Section titled “Schemas”Returns the list of identity providers for an organization — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
identity_providers | array | Optional | |
identity_providers[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a single identity provider. |
auto_provision_users | boolean | Optional | When **true,** users who use this identity provider are automatically provisioned. |
friendly_name | string | Optional | The human-readable name of the identity provider. |
id | string | Optional | The unique ID of the identity provider. Format: uuid |
links | array | Optional | A list of useful URLs. |
links[] | Model | Each item | Expand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item |
saml_20 | Model | Optional | Expand 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. |
type | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A link to a useful URL. |
href | string | Optional | The URL of the linked item. |
rel | string | Optional | The kind of linked item. |
Returns the list of identity providers for an organization — response body — identity providers item saml 20
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a SAML 2.0 identity provider. |
attribute_mappings | array | Optional | A list of attribute mappings. |
attribute_mappings[] | Model | Each item | Expand Returns the list of identity providers for an organization — response body — identity providers item saml 20 attribute mappings item |
certificates | array | Optional | A list of certificates responses. |
certificates[] | Model | Each item | Expand Returns the list of identity providers for an organization — response body — identity providers item saml 20 certificates item |
issuer | string | Optional | The name of the certificate issuer. |
settings | array | Optional | A list of settings. |
settings[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Information about a single certificate. |
expiration_date | string | Optional | The date when the certificate expires. Format: date-time |
id | string | Optional | The unique ID of the certificate. Format: uuid |
is_valid | boolean | Optional | When **true,** the certificate is valid. Read only: true |
issuer | string | Optional | The certificate issuer. |
links | array | Optional | A list of useful links. |
links[] | Model | Each item | Expand Returns a list of organizations that the authenticated user belongs to — response body — organizations item links item |
thumbprint | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single attribute mapping response. |
required_attribute_friendly_name | string | Optional | The human-readable name of the attribute. |
required_attribute_id | JSON | Optional | |
required_attribute_id (anyOf 1) | integer | Alternative | The unique ID of the attribute. Format: int32 |
required_attribute_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
required_attribute_name | string | Optional | The name of the attribute. |
substitute_attribute_name | string | Optional | The name of the substitute attribute. |
Returns the list of reserved domains for the organization — response body — reserved domains item settings item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A key/value list of settings. |
key | string | Optional | The key of the setting. |
type | string | Optional | The type of the setting. One of: - `unknown` - `guid` - `text` - `integer` - `boolean` - `datetime` - `enumeration` |
value | object | Optional | The value of the setting. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]