Skip to main content
GET
Python

Authorizations

Authorization
string
header
required

Enter your JWT token

Path Parameters

id
integer<int32>
required

The auth provider id.

Response

The auth provider.

An account's auth provider for one authentication method of one application: the values of the method's "Set on provider" connection fields, filled once and used by every connection signed in through it. A password field's value is write-only and never appears in a response.

id
integer<int32>
required

Auth provider id.

providerName
string
required

The account's label for the provider.

applicationId
integer<int32>
required

The application (published connector) the provider belongs to.

sourceAuthenticationId
integer<int32>
required

The authentication method of the application this provider supplies an OAuth client for.

isDefault
boolean
required

Whether this is the application's default provider: new connections to the application preselect it and its method. At most one per application.

isSandbox
boolean
required

Whether the provider is for the vendor's sandbox environment.

status
integer<int32>
required

1 = active, 0 = disabled (no new sign-ins).

connectorRemoved
boolean
required

True when the application has been removed; the provider can then only be deleted.

noLongerSupported
boolean
required

True when the connector no longer allows auth providers on this method. Connections already signed in keep working; new sign-ins are refused.

connectionCount
integer<int32>
required

Number of connections signed in through this provider.

fields
object[]
required

The source method's "Set on provider" connection fields and their values on this provider. A password field never carries its value - only HasValue.

fieldsNeedReview
boolean
required

True when the provider fields need attention: the connector changed which fields are set on the provider (or whether one is secret) since the values were entered, or a required value is missing.

applicationName
string | null

The application's name, when it is still available.

applicationLogo
string | null

The application's logo file, when it is still available.

sourceAuthenticationName
string | null

Display name of that authentication method.

scopesOverride
string | null

Scopes that replace the method's own scope option; null keeps the method's scopes.

extraOptions
string | null

Additional non-URL OAuth options as a JSON object of strings.