Skip to main content
GET
/
oauth-providers
List all OAuth2.0 Identity providers that are registered in the portal
curl --request GET \
  --url http://localhost:3001/portal-api/oauth-providers \
  --header 'Authorization: <api-key>'
[
  {
    "Name": "<string>",
    "Type": "Keycloak",
    "WellKnownURL": "<string>",
    "SSLInsecureSkipVerify": true,
    "ID": 123,
    "CreatedAt": "<string>",
    "UpdatedAt": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Response

200 - application/json

OK

​
Name
string
required

Name of this Identity Provider

​
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
​
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.

​
SSLInsecureSkipVerify
boolean

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

​
ID
integer

UID of this Identity Provider

​
CreatedAt
string

Timestamp of when this Identity provider was created

​
UpdatedAt
string

Timestamp of when this Identity provider was created