Britive platform release 2026.09.02 is now live in production.

Get identity provider details

Prev Next
Get
/api/workload/identity-providers/{idpId}
Security
HTTP
Type bearer
Path parameters
idpId
integer (int32) Required

Id of the identity provider.

Responses
200

identity provider retrieved

Expand All
OneOf
AwsProvider
object (AwsProvider)
id
integer (int32)
name
string
description
string
attributesMap
Array of object (AttributeMap)

Provider's identity attributes mapped to Britive service identity custom attributes.

object

Single identity provider attribute mapped to service identity custom attribute

idpAttr
string
userAttr
string
matchType
string

How the service identity's mapped attribute value is compared against the incoming token claim. EXACT compares literally. REGEX treats the stored value as a regular expression, applied fully anchored and case-insensitively by default; a pattern may opt into case-sensitive matching with the inline (?-i) modifier.

Optional, and omitting it means EXACT. Because updating an identity provider replaces its attribute map, a client that omits this field when updating a provider resets any mapping that was REGEX back to EXACT. The stored value is then compared literally, so a pattern such as repo:myorg/myrepo:ref:refs/heads/feature/.* will no longer match any token and the identities relying on it stop authenticating. Clients that update identity providers must read the current match type and send it back, not omit it.

Valid values[ "EXACT", "REGEX" ]
Default"EXACT"
validationWindow
integer (int32)

The amount of time in seconds, after the token has been issued/signed, Britive will attempt to validate the unverified token. Outside this window, token validation will fail.

idpType
string
maxDuration
integer (int32)

The maximum number of hours the client can request the AWS token be valid.

OpenIdConnectProvider
object (OpenIdConnectProvider)
id
integer (int32)
name
string
description
string
attributesMap
Array of object (AttributeMap)

Provider's identity attributes mapped to Britive service identity custom attributes.

object

Single identity provider attribute mapped to service identity custom attribute

idpAttr
string
userAttr
string
matchType
string

How the service identity's mapped attribute value is compared against the incoming token claim. EXACT compares literally. REGEX treats the stored value as a regular expression, applied fully anchored and case-insensitively by default; a pattern may opt into case-sensitive matching with the inline (?-i) modifier.

Optional, and omitting it means EXACT. Because updating an identity provider replaces its attribute map, a client that omits this field when updating a provider resets any mapping that was REGEX back to EXACT. The stored value is then compared literally, so a pattern such as repo:myorg/myrepo:ref:refs/heads/feature/.* will no longer match any token and the identities relying on it stop authenticating. Clients that update identity providers must read the current match type and send it back, not omit it.

Valid values[ "EXACT", "REGEX" ]
Default"EXACT"
validationWindow
integer (int32)

The amount of time in seconds, after the token has been issued/signed, Britive will attempt to validate the unverified token. Outside this window, token validation will fail.

idpType
string
issuerUrl
string
allowedAudiences
Array of string
string
SpiffeProvider
object (SpiffeProvider)
id
integer (int32)
name
string
description
string
attributesMap
Array of object (AttributeMap)

Provider's identity attributes mapped to Britive service identity custom attributes.

object

Single identity provider attribute mapped to service identity custom attribute

idpAttr
string
userAttr
string
matchType
string

How the service identity's mapped attribute value is compared against the incoming token claim. EXACT compares literally. REGEX treats the stored value as a regular expression, applied fully anchored and case-insensitively by default; a pattern may opt into case-sensitive matching with the inline (?-i) modifier.

Optional, and omitting it means EXACT. Because updating an identity provider replaces its attribute map, a client that omits this field when updating a provider resets any mapping that was REGEX back to EXACT. The stored value is then compared literally, so a pattern such as repo:myorg/myrepo:ref:refs/heads/feature/.* will no longer match any token and the identities relying on it stop authenticating. Clients that update identity providers must read the current match type and send it back, not omit it.

Valid values[ "EXACT", "REGEX" ]
Default"EXACT"
validationWindow
integer (int32)

The amount of time in seconds, after the token has been issued/signed, Britive will attempt to validate the unverified token. Outside this window, token validation will fail.

idpType
string
bundleEndpoint
string (uri)
bundleProfile
string

the SPIFFE bundle endpoint profile

Valid values[ "https_web", "https_spiffe" ]
trustDomain
string
404

identity provider not found