Apache CloudStack 4.23.0.0 Root Admin API Reference
registerOauthProvider
Register the OAuth2 provider in CloudStack
Request parameters
| Parameter Name | Description | Required |
| clientid | Client ID pre-registered in the specific OAuth provider | true |
| description | Description of the OAuth Provider | true |
| provider | Name of the provider from the list of OAuth providers supported in CloudStack | true |
| redirecturi | Redirect URI pre-registered in the specific OAuth provider | true |
| secretkey | Secret Key pre-registered in the specific OAuth provider | true |
| authorizeurl | Authorize URL for OAuth initialization (only required for keycloak provider) | false |
| details | Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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 | false |
| domain | Domain path for domain-specific OAuth provider. Ignored when Domain ID is passed. | false |
| domainid | Domain ID for domain-specific OAuth provider. If not provided, registers as global provider | false |
| tokenurl | Token URL for OAuth finalization (only required for keycloak provider) | false |
Response Tags
| Response Name | Description |
| displaytext | Any text associated with the success or failure |
| success | True if operation is executed successfully |