Skip to main content

IdentityProvider

ResourceHaste Health

External identity provider configuration.

Tested supportFull test results →
Backends
PostgreSQLElasticsearch
Interactions
CreateReadUpdatePatchDelete
Search
2 of 3 parameters tested

Structure​

ElementCard.TypeDescription
nameRequired
1..1stringThe name of the external identity provider.
statusRequired
1..1codeThe status of the identity provider.Binding (required): IdentityProviderStatus
accessTypeRequired
1..1codeMethod for connecting to external identity provider.Binding (required): IdentityProviderAccessType
oidc
0..1BackboneElementOIDC connection configuration for the identity provider.
authorization_endpointRequired
1..1stringOIDC authorization endpoint.
token_endpointRequired
1..1stringOIDC token endpoint.
userinfo_endpoint
0..1stringThe OIDC user info endpoint.
jwks_uri
0..1stringIf included will verify id token based on this jwks keys.
scopes
0..*stringScopes to send to the OIDC provider.
clientRequired
1..1BackboneElementRegistered client for the OIDC provider.
clientIdRequired
1..1stringRegistered clients id.
secret
0..1stringRegistered clients secret.
pkce
0..1BackboneElementPKCE Configuration
code_challenge_method
0..1codePKCE code challenge method.Binding (required): IdentityProviderPKCEChallengeMethod
enabled
0..1booleanPKCE enabled.

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters​

Query with GET [base]/IdentityProvider?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

ParameterTypeDescriptionPGES
accessTypetoken

An identity providers accessType.

IdentityProvider.accessType
namestring

An identity providers name.

IdentityProvider.name
statustoken

An identity providers status.

IdentityProvider.status

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)
_haste-health-authorreference

The author of the resource

_idtoken

Logical id of this artifact

_lastUpdateddate

When the resource version last changed

_profileuri

Profiles this resource claims to conform to

_securitytoken

Security Labels applied to this resource

_sourceuri

Identifies where the resource comes from

_tagtoken

Tags applied to this resource

_typetoken

Derived from the R4B Definition