POST
/
oauth-providers
Register a new OAuth2.0 Identity Provider in the portal
curl --request POST \
  --url http://localhost:3001/portal-api/oauth-providers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "Name": "My Keycloak instance",
  "Type": "Keycloak",
  "WellKnownURL": "http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect",
  "SSLInsecureSkipVerify": false,
  "RegistrationAccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc"
}'
{
  "Name": "My Keycloak instance",
  "Type": "Keycloak",
  "WellKnownURL": "http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect",
  "SSLInsecureSkipVerify": false,
  "ID": 1,
  "CreatedAt": "2023-06-25 13:37",
  "UpdatedAt": "2023-06-25 13:37"
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
Name
string
required

Name of this Identity Provider

Examples:

"My Keycloak instance"

​
Type
enum<string>
required

Type of the identity provider. At the moment we support Keycloak, Gluu, and Okta. If your provider is not in the list but it is compliant with the Dynamic Client Registration protocol, select Other.

Available options:
Keycloak,
Gluu,
Okta,
Other
Examples:

"Keycloak"

"Gluu"

"Okta"

"Other"

​
WellKnownURL
string
required

The well-known endpoint provides metadata about the OpenID Connect Identity Provider, facilitating dynamic client registration by allowing clients to discover configuration details such as registration endpoints automatically. Check documentation of your Identity provider for more information.

Examples:

"http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect"

​
SSLInsecureSkipVerify
boolean

If enabled, the portal will ignore failed SSL checks when connecting to the Identity provider

Examples:

false

​
RegistrationAccessToken
string

This token is used solely for registering a specific instance of the application.

Examples:

"eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICI5MGVmNWRmYy1hNTViLTQ0N2MtODg4ZS1lNjNkNjEwMDc1ZTMifQ.eyJleHAiOjE3OTYyMjQ4MTUsImlhdCI6MTcwOTgyNDgxNSwianRpIjoiMGNiZjMyYmYtZTdmYi00M2U2LTkwNzEtZmNjMGE3YWMzZGNiIiwiaXNzIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgwL2F1dGgvcmVhbG1zL0RDUiIsImF1ZCI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MC9hdXRoL3JlYWxtcy9EQ1IiLCJ0eXAiOiJJbml0aWFsQWNjZXNzVG9rZW4ifQ.KHx7faY5-DTgUVOKj8aK9RSmM_xRcXf7LJfgHOmPGzc"

Response

OK

​
Name
string
required

Name of this Identity Provider

Examples:

"My Keycloak instance"

​
Type
enum<string>
required

Type of the identity provider. At the moment we support Keycloak, Gluu, and Okta. If your provider is not in the list but it is compliant with the Dynamic Client Registration protocol, select Other.

Available options:
Keycloak,
Gluu,
Okta,
Other
Examples:

"Keycloak"

"Gluu"

"Okta"

"Other"

​
WellKnownURL
string
required

The well-known endpoint provides metadata about the OpenID Connect Identity Provider, facilitating dynamic client registration by allowing clients to discover configuration details such as registration endpoints automatically. Check documentation of your Identity provider for more information.

Examples:

"http://localhost:8080/auth/realms/DCR/clients-registrations/openid-connect"

​
SSLInsecureSkipVerify
boolean

If enabled, the portal will ignore failed SSL checks when connecting to the Identity provider

Examples:

false

​
ID
integer

UID of this Identity Provider

Examples:

1

​
CreatedAt
string

Timestamp of when this Identity provider was created

Examples:

"2023-06-25 13:37"

​
UpdatedAt
string

Timestamp of when this Identity provider was created

Examples:

"2023-06-25 13:37"