HTTP Example:GET /v310/appliance/authProvider
| API Example: ApplianceResource.getAuthProvider({}); |
Description:Returns the current Identity Providers configurations. Used to create the authorize request to the
IdP as part of the Authorization Code Grant workflow.- Since API version
- v310.151
- Tintri Api Server Support:
- All
- Output:
- AuthProvider -
- Produces:
- application/json;qs=1, application/xml;qs=0.5
- Consumes:
- application/json;qs=1, application/xml;qs=0.5
|
HTTP Example:DELETE /v310/appliance/authProvider
| API Example: ApplianceResource.deleteAuthProvider({}); |
Description:Delete the Auth Provider.- Since API version
- v310.151
- Tintri Api Server Support:
- All
- Output:
- void
- Errors:
| Error Code | Message | HTTP Response Code | | ERR-API-8001 | Resource not found | 404 |
- Produces:
- application/json;qs=1, application/xml;qs=0.5
- Consumes:
- application/json;qs=1, application/xml;qs=0.5
|
HTTP Example:POST /v310/appliance/authProvider
| API Example: ApplianceResource.setAuthProvider({'$entity': }); |
Description:Create the Authentication Provider which contains the OAuth 2 configurations used to SSO authenticate the user.- Since API version
- v310.151
- Tintri Api Server Support:
- All
- Input:
- AuthProvider
- Output:
- AuthProvider -
- Errors:
| Error Code | Message | HTTP Response Code | | ERR-API-6019 | Invalid argument | 422 | | ERR-API-0306 | Failed to create an AuthProvider | 500 |
- Produces:
- application/json;qs=1, application/xml;qs=0.5
- Consumes:
- application/json;qs=1, application/xml;qs=0.5
|
HTTP Example:PUT /v310/appliance/authProvider
| API Example: ApplianceResource.updateAuthProvider({'$entity': }); |
Description:Update the Auth Provider. All provided fields will be used to update the object.- Since API version
- v310.151
- Tintri Api Server Support:
- All
- Input:
- AuthProvider
- Output:
- AuthProvider -
- Errors:
| Error Code | Message | HTTP Response Code | | ERR-API-6019 | Invalid argument | 422 | | ERR-API-0306 | Failed to create an AuthProvider | 500 |
- Produces:
- application/json;qs=1, application/xml;qs=0.5
- Consumes:
- application/json;qs=1, application/xml;qs=0.5
|