Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 5. Auth Provider Service

5.1. Auth Provider Service

5.1.1. DeleteAuthProvider

DELETE /v1/authProviders/{id}

5.1.1.1. Description

5.1.1.2. Parameters

5.1.1.2.1. Path Parameters
NameDescriptionRequiredDefaultPattern

id

 

X

null

 
5.1.1.2.2. Query Parameters
NameDescriptionRequiredDefaultPattern

force

 

-

null

 

5.1.1.3. Return Type

Object

5.1.1.4. Content Type

  • application/json

5.1.1.5. Responses

Table 5.1. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GooglerpcStatus

5.1.1.6. Samples

5.1.2. ExchangeToken

POST /v1/authProviders/exchangeToken

5.1.2.1. Description

5.1.2.2. Parameters

5.1.2.2.1. Body Parameter
NameDescriptionRequiredDefaultPattern

body

V1ExchangeTokenRequest

X

  

5.1.2.3. Return Type

V1ExchangeTokenResponse

5.1.2.4. Content Type

  • application/json

5.1.2.5. Responses

Table 5.2. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1ExchangeTokenResponse

0

An unexpected error response.

GooglerpcStatus

5.1.2.6. Samples

5.1.3. GetAuthProvider

GET /v1/authProviders/{id}

5.1.3.1. Description

5.1.3.2. Parameters

5.1.3.2.1. Path Parameters
NameDescriptionRequiredDefaultPattern

id

 

X

null

 

5.1.3.3. Return Type

StorageAuthProvider

5.1.3.4. Content Type

  • application/json

5.1.3.5. Responses

Table 5.3. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

StorageAuthProvider

0

An unexpected error response.

GooglerpcStatus

5.1.3.6. Samples

5.1.4. GetAuthProviders

GET /v1/authProviders

5.1.4.1. Description

5.1.4.2. Parameters

5.1.4.2.1. Query Parameters
NameDescriptionRequiredDefaultPattern

name

 

-

null

 

type

 

-

null

 

5.1.4.3. Return Type

V1GetAuthProvidersResponse

5.1.4.4. Content Type

  • application/json

5.1.4.5. Responses

Table 5.4. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1GetAuthProvidersResponse

0

An unexpected error response.

GooglerpcStatus

5.1.4.6. Samples

5.1.5. GetLoginAuthProviders

GET /v1/login/authproviders

5.1.5.1. Description

5.1.5.2. Parameters

5.1.5.3. Return Type

V1GetLoginAuthProvidersResponse

5.1.5.4. Content Type

  • application/json

5.1.5.5. Responses

Table 5.5. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1GetLoginAuthProvidersResponse

0

An unexpected error response.

GooglerpcStatus

5.1.5.6. Samples

5.1.6. ListAvailableProviderTypes

GET /v1/availableAuthProviders

5.1.6.1. Description

5.1.6.2. Parameters

5.1.6.3. Return Type

V1AvailableProviderTypesResponse

5.1.6.4. Content Type

  • application/json

5.1.6.5. Responses

Table 5.6. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1AvailableProviderTypesResponse

0

An unexpected error response.

GooglerpcStatus

5.1.6.6. Samples

5.1.7. PostAuthProvider

POST /v1/authProviders

5.1.7.1. Description

5.1.7.2. Parameters

5.1.7.2.1. Body Parameter
NameDescriptionRequiredDefaultPattern

provider

StorageAuthProvider

X

  

5.1.7.3. Return Type

StorageAuthProvider

5.1.7.4. Content Type

  • application/json

5.1.7.5. Responses

Table 5.7. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

StorageAuthProvider

0

An unexpected error response.

GooglerpcStatus

5.1.7.6. Samples

5.1.8. PutAuthProvider

PUT /v1/authProviders/{id}

5.1.8.1. Description

5.1.8.2. Parameters

5.1.8.2.1. Path Parameters
NameDescriptionRequiredDefaultPattern

id

 

X

null

 
5.1.8.2.2. Body Parameter
NameDescriptionRequiredDefaultPattern

body

AuthProviderServicePutAuthProviderBody

X

  

5.1.8.3. Return Type

StorageAuthProvider

5.1.8.4. Content Type

  • application/json

5.1.8.5. Responses

Table 5.8. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

StorageAuthProvider

0

An unexpected error response.

GooglerpcStatus

5.1.8.6. Samples

5.1.9. UpdateAuthProvider

PATCH /v1/authProviders/{id}

5.1.9.1. Description

5.1.9.2. Parameters

5.1.9.2.1. Path Parameters
NameDescriptionRequiredDefaultPattern

id

 

X

null

 
5.1.9.2.2. Body Parameter
NameDescriptionRequiredDefaultPattern

body

AuthProviderServiceUpdateAuthProviderBody

X

  

5.1.9.3. Return Type

StorageAuthProvider

5.1.9.4. Content Type

  • application/json

5.1.9.5. Responses

Table 5.9. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

StorageAuthProvider

0

An unexpected error response.

GooglerpcStatus

5.1.9.6. Samples

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat