Questo contenuto non è disponibile nella lingua selezionata.
Chapter 6. Auth Service
6.1. Auth Service Copia collegamentoCollegamento copiato negli appunti!
6.1.1. AddAuthMachineToMachineConfig Copia collegamentoCollegamento copiato negli appunti!
POST /v1/auth/m2m
AddAuthMachineToMachineConfig creates a new auth machine to machine config.
6.1.1.1. Description Copia collegamentoCollegamento copiato negli appunti!
6.1.1.2. Parameters Copia collegamentoCollegamento copiato negli appunti!
6.1.1.2.1. Body Parameter Copia collegamentoCollegamento copiato negli appunti!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
6.1.1.3. Return Type Copia collegamentoCollegamento copiato negli appunti!
6.1.1.4. Content Type Copia collegamentoCollegamento copiato negli appunti!
- application/json
6.1.1.5. Responses Copia collegamentoCollegamento copiato negli appunti!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
6.1.1.6. Samples Copia collegamentoCollegamento copiato negli appunti!
6.1.2. DeleteAuthMachineToMachineConfig Copia collegamentoCollegamento copiato negli appunti!
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 Copia collegamentoCollegamento copiato negli appunti!
6.1.2.2. Parameters Copia collegamentoCollegamento copiato negli appunti!
6.1.2.2.1. Path Parameters Copia collegamentoCollegamento copiato negli appunti!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
6.1.2.3. Return Type Copia collegamentoCollegamento copiato negli appunti!
Object
6.1.2.4. Content Type Copia collegamentoCollegamento copiato negli appunti!
- application/json
6.1.2.5. Responses Copia collegamentoCollegamento copiato negli appunti!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |
6.1.2.6. Samples Copia collegamentoCollegamento copiato negli appunti!
6.1.3. ExchangeAuthMachineToMachineToken Copia collegamentoCollegamento copiato negli appunti!
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 Copia collegamentoCollegamento copiato negli appunti!
6.1.3.2. Parameters Copia collegamentoCollegamento copiato negli appunti!
6.1.3.2.1. Body Parameter Copia collegamentoCollegamento copiato negli appunti!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
6.1.3.3. Return Type Copia collegamentoCollegamento copiato negli appunti!
6.1.3.4. Content Type Copia collegamentoCollegamento copiato negli appunti!
- application/json
6.1.3.5. Responses Copia collegamentoCollegamento copiato negli appunti!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
6.1.3.6. Samples Copia collegamentoCollegamento copiato negli appunti!
6.1.4. GetAuthMachineToMachineConfig Copia collegamentoCollegamento copiato negli appunti!
GET /v1/auth/m2m/{id}
GetAuthMachineToMachineConfig retrieves the specific auth machine to machine config.
6.1.4.1. Description Copia collegamentoCollegamento copiato negli appunti!
6.1.4.2. Parameters Copia collegamentoCollegamento copiato negli appunti!
6.1.4.2.1. Path Parameters Copia collegamentoCollegamento copiato negli appunti!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| id | X | null |
6.1.4.3. Return Type Copia collegamentoCollegamento copiato negli appunti!
6.1.4.4. Content Type Copia collegamentoCollegamento copiato negli appunti!
- application/json
6.1.4.5. Responses Copia collegamentoCollegamento copiato negli appunti!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
6.1.4.6. Samples Copia collegamentoCollegamento copiato negli appunti!
6.1.5. GetAuthStatus Copia collegamentoCollegamento copiato negli appunti!
GET /v1/auth/status
GetAuthStatus returns the status for the current client.
6.1.5.1. Description Copia collegamentoCollegamento copiato negli appunti!
6.1.5.2. Parameters Copia collegamentoCollegamento copiato negli appunti!
6.1.5.3. Return Type Copia collegamentoCollegamento copiato negli appunti!
6.1.5.4. Content Type Copia collegamentoCollegamento copiato negli appunti!
- application/json
6.1.5.5. Responses Copia collegamentoCollegamento copiato negli appunti!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
6.1.5.6. Samples Copia collegamentoCollegamento copiato negli appunti!
6.1.6. ListAuthMachineToMachineConfigs Copia collegamentoCollegamento copiato negli appunti!
GET /v1/auth/m2m
ListAuthMachineToMachineConfigs lists the available auth machine to machine configs.
6.1.6.1. Description Copia collegamentoCollegamento copiato negli appunti!
6.1.6.2. Parameters Copia collegamentoCollegamento copiato negli appunti!
6.1.6.3. Return Type Copia collegamentoCollegamento copiato negli appunti!
6.1.6.4. Content Type Copia collegamentoCollegamento copiato negli appunti!
- application/json
6.1.6.5. Responses Copia collegamentoCollegamento copiato negli appunti!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. | |
| 0 | An unexpected error response. |
6.1.6.6. Samples Copia collegamentoCollegamento copiato negli appunti!
6.1.7. UpdateAuthMachineToMachineConfig Copia collegamentoCollegamento copiato negli appunti!
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 Copia collegamentoCollegamento copiato negli appunti!
6.1.7.2. Parameters Copia collegamentoCollegamento copiato negli appunti!
6.1.7.2.1. Path Parameters Copia collegamentoCollegamento copiato negli appunti!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| 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 Copia collegamentoCollegamento copiato negli appunti!
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
| body | X |
6.1.7.3. Return Type Copia collegamentoCollegamento copiato negli appunti!
Object
6.1.7.4. Content Type Copia collegamentoCollegamento copiato negli appunti!
- application/json
6.1.7.5. Responses Copia collegamentoCollegamento copiato negli appunti!
| Code | Message | Datatype |
|---|---|---|
| 200 | A successful response. |
|
| 0 | An unexpected error response. |