IdentityProviders: getIdentityProviders

Required scopes: identity_provider_read

Returns a list of the identity providers associated with an organization.

Request

HTTP request

GET /v2/organizations/{organizationId}/identity_providers

Parameters

Parameter NameValueDescription
Path Parameters
organizationIdstring

The organization ID Guid

Responses

CodeDescriptionReference
200

OK

IdentityProviders

SDK Method

IdentityProviders::getIdentityProviders

Definitions

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.LinkResponse

A link to a useful URL.

relstring

The kind of linked item.

hrefstring

URL of the linked item.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.SettingResponse

A key/value list of settings.

keystring

The key of the setting.

valueobject

The value of the setting.

typestring

The type of the setting. One of:

  • unknown
  • guid
  • text
  • integer
  • boolean
  • datetime
  • enumeration

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.IdentityProviderResponse

Information about a single identity provider.

idstring

The unique ID of the identity provider.

friendly_namestring

The human-readable name of the identity provider.

auto_provision_usersboolean

If true, users who use this identity provider are automatically provisioned.

typestring

The type of the identity provider. One of:

  • none
  • saml_20
  • saml_11
  • saml_10
  • ws_federation
  • open_id_connect

saml_20DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.Saml2IdentityProviderResponse

If type is saml_20, details about the SAML 2.0 response.

links[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.LinkResponse]

List of useful URLs.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.Saml2IdentityProviderResponse

Information about a SAML 2.0 identity provider.

issuerstring

The name of the certificate issuer.

settings[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.SettingResponse]

A list of settings.

certificates[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.CertificateResponse]

A list of certificates responses.

attribute_mappings[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.RequiredAttributeMappingResponse]

A list of attribute mappings.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.CertificateResponse

Information about a single certificate.

idstring

Unique ID of the certificate.

issuerstring

The certificate issuer.

thumbprintstring

Thumbprint of the certificate.

expiration_datestring

Date when the certificate expires.

is_validboolean

If true, the certificate is valid.

links[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.LinkResponse]

A list of useful links.

DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.RequiredAttributeMappingResponse

A single attribute mapping response.

required_attribute_idinteger

The unique ID of the attribute.

required_attribute_namestring

The name of the attribute.

required_attribute_friendly_namestring

The human-readable name of the attribute.

substitute_attribute_namestring

Name of the substitute attribute.

IdentityProviders

Methods to get a list of identity providers.

identity_providers[DocuSign.API.Organizations.Web.Models.RestApi.v2.Response.IdentityProviderResponse]

A list of identity providers.

}} />