Questo contenuto non è disponibile nella lingua selezionata.

Chapter 6. Auth Service


6.1. Auth Service

6.1.1. AddAuthMachineToMachineConfig

POST /v1/auth/m2m

AddAuthMachineToMachineConfig creates a new auth machine to machine config.

6.1.1.1. Description

6.1.1.2. Parameters

6.1.1.2.1. Body Parameter
Expand
NameDescriptionRequiredDefaultPattern

body

V1AddAuthMachineToMachineConfigRequest

X

  

6.1.1.3. Return Type

V1AddAuthMachineToMachineConfigResponse

6.1.1.4. Content Type

  • application/json

6.1.1.5. Responses

Expand
Table 6.1. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1AddAuthMachineToMachineConfigResponse

0

An unexpected error response.

GooglerpcStatus

6.1.1.6. Samples

6.1.2. DeleteAuthMachineToMachineConfig

DELETE /v1/auth/m2m/{id}

DeleteAuthMachineToMachineConfig deletes the specific auth machine to machine config. In case a specified auth machine to machine config does not exist is deleted, no error will be returned.

6.1.2.1. Description

6.1.2.2. Parameters

6.1.2.2.1. Path Parameters
Expand
NameDescriptionRequiredDefaultPattern

id

 

X

null

 

6.1.2.3. Return Type

Object

6.1.2.4. Content Type

  • application/json

6.1.2.5. Responses

Expand
Table 6.2. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GooglerpcStatus

6.1.2.6. Samples

6.1.3. ExchangeAuthMachineToMachineToken

POST /v1/auth/m2m/exchange

ExchangeAuthMachineToMachineToken exchanges a given identity token for a Central access token based on configured auth machine to machine configs.

6.1.3.1. Description

6.1.3.2. Parameters

6.1.3.2.1. Body Parameter
Expand
NameDescriptionRequiredDefaultPattern

body

V1ExchangeAuthMachineToMachineTokenRequest

X

  

6.1.3.3. Return Type

V1ExchangeAuthMachineToMachineTokenResponse

6.1.3.4. Content Type

  • application/json

6.1.3.5. Responses

Expand
Table 6.3. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1ExchangeAuthMachineToMachineTokenResponse

0

An unexpected error response.

GooglerpcStatus

6.1.3.6. Samples

6.1.4. GetAuthMachineToMachineConfig

GET /v1/auth/m2m/{id}

GetAuthMachineToMachineConfig retrieves the specific auth machine to machine config.

6.1.4.1. Description

6.1.4.2. Parameters

6.1.4.2.1. Path Parameters
Expand
NameDescriptionRequiredDefaultPattern

id

 

X

null

 

6.1.4.3. Return Type

V1GetAuthMachineToMachineConfigResponse

6.1.4.4. Content Type

  • application/json

6.1.4.5. Responses

Expand
Table 6.4. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1GetAuthMachineToMachineConfigResponse

0

An unexpected error response.

GooglerpcStatus

6.1.4.6. Samples

6.1.5. GetAuthStatus

GET /v1/auth/status

GetAuthStatus returns the status for the current client.

6.1.5.1. Description

6.1.5.2. Parameters

6.1.5.3. Return Type

V1AuthStatus

6.1.5.4. Content Type

  • application/json

6.1.5.5. Responses

Expand
Table 6.5. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1AuthStatus

0

An unexpected error response.

GooglerpcStatus

6.1.5.6. Samples

6.1.6. ListAuthMachineToMachineConfigs

GET /v1/auth/m2m

ListAuthMachineToMachineConfigs lists the available auth machine to machine configs.

6.1.6.1. Description

6.1.6.2. Parameters

6.1.6.3. Return Type

V1ListAuthMachineToMachineConfigResponse

6.1.6.4. Content Type

  • application/json

6.1.6.5. Responses

Expand
Table 6.6. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

V1ListAuthMachineToMachineConfigResponse

0

An unexpected error response.

GooglerpcStatus

6.1.6.6. Samples

6.1.7. UpdateAuthMachineToMachineConfig

PUT /v1/auth/m2m/{config.id}

UpdateAuthMachineToMachineConfig updates an existing auth machine to machine config. In case the auth machine to machine config does not exist, a new one will be created.

6.1.7.1. Description

6.1.7.2. Parameters

6.1.7.2.1. Path Parameters
Expand
NameDescriptionRequiredDefaultPattern

config.id

UUID of the config. Note that when adding a machine to machine config, this field should not be set.

X

null

 
6.1.7.2.2. Body Parameter
Expand
NameDescriptionRequiredDefaultPattern

body

AuthServiceUpdateAuthMachineToMachineConfigBody

X

  

6.1.7.3. Return Type

Object

6.1.7.4. Content Type

  • application/json

6.1.7.5. Responses

Expand
Table 6.7. HTTP Response Codes
CodeMessageDatatype

200

A successful response.

Object

0

An unexpected error response.

GooglerpcStatus

6.1.7.6. Samples

Torna in cima
Red Hat logoGithubredditYoutubeTwitter

Formazione

Prova, acquista e vendi

Community

Informazioni sulla documentazione di Red Hat

Aiutiamo gli utenti Red Hat a innovarsi e raggiungere i propri obiettivi con i nostri prodotti e servizi grazie a contenuti di cui possono fidarsi. Esplora i nostri ultimi aggiornamenti.

Rendiamo l’open source più inclusivo

Red Hat si impegna a sostituire il linguaggio problematico nel codice, nella documentazione e nelle proprietà web. Per maggiori dettagli, visita il Blog di Red Hat.

Informazioni su Red Hat

Forniamo soluzioni consolidate che rendono più semplice per le aziende lavorare su piattaforme e ambienti diversi, dal datacenter centrale all'edge della rete.

Theme

© 2025 Red Hat