Update an OAuth2.0 Identity Provider

curl --request PUT \
  --url http://localhost:3001/portal-api/oauth-providers/{provider_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Name": "<string>",
  "Type": "Keycloak",
  "WellKnownURL": "<string>",
  "SSLInsecureSkipVerify": true,
  "RegistrationAccessToken": "<string>"
}
'

{
  "Name": "<string>",
  "Type": "Keycloak",
  "WellKnownURL": "<string>",
  "ClientTypes": [
    {
      "Name": "<string>",
      "ResponseTypes": "code",
      "GrantType": "authorization_code",
      "Description": "<string>",
      "TokenEndpointAuthMethod": "client_secret_basic",
      "OktaAppType": "web",
      "ID": 123,
      "CreatedAt": "<string>",
      "UpdatedAt": "<string>"
    }
  ],
  "SSLInsecureSkipVerify": true,
  "ID": 123,
  "CreatedAt": "<string>",
  "UpdatedAt": "<string>"
}

PUT

oauth-providers

{provider_id}

Update an OAuth2.0 Identity Provider

curl --request PUT \
  --url http://localhost:3001/portal-api/oauth-providers/{provider_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Name": "<string>",
  "Type": "Keycloak",
  "WellKnownURL": "<string>",
  "SSLInsecureSkipVerify": true,
  "RegistrationAccessToken": "<string>"
}
'

{
  "Name": "<string>",
  "Type": "Keycloak",
  "WellKnownURL": "<string>",
  "ClientTypes": [
    {
      "Name": "<string>",
      "ResponseTypes": "code",
      "GrantType": "authorization_code",
      "Description": "<string>",
      "TokenEndpointAuthMethod": "client_secret_basic",
      "OktaAppType": "web",
      "ID": 123,
      "CreatedAt": "<string>",
      "UpdatedAt": "<string>"
    }
  ],
  "SSLInsecureSkipVerify": true,
  "ID": 123,
  "CreatedAt": "<string>",
  "UpdatedAt": "<string>"
}

Authorizations

Authorization

string

header

required

Path Parameters

provider_id

integer

required

UID of this OAuth2.0 provider

Example:

1

Body

application/json

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

RegistrationAccessToken

string

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

Response

Name

string

required

Name of this Identity Provider

Type

enum<string>

required

Available options:

Keycloak,

Gluu,

Okta,

Other

WellKnownURL

string

required

ClientTypes

object[]

required

OAuth2.0 client types associated with this Identity Provider

Show child attributes

ClientTypes.Name

string

required

Name of this Client type

ClientTypes.ResponseTypes

enum<string>

required

The OAuth 2.0 response type(s) the client is permitted to use, determining how it receives authorization responses from the Identity Provider. Format as CSV and Specify at least one.

Available options:

code,

token,

it_token,

none

ClientTypes.GrantType

enum<string>

required

The OAuth 2.0 grant types the client is permitted to use, determining how it obtains access tokens from the authorization server. Format as CSV and Specify at least one.

Available options:

authorization_code,

pkce,

client_credentials,

device_code,

refresh_token,

password,

implicit

ClientTypes.Description

string

Description of this Client type

ClientTypes.TokenEndpointAuthMethod

enum<string>

The authentication method a client can use at the token endpoint, ensuring secure communication with the authorization server during the OAuth 2.0 authentication.

Available options:

client_secret_basic,

client_secret_post

ClientTypes.OktaAppType

enum<string>

Dictates how an application will authenticate and interact with Okta's authorization servers, including whether it operates as a web, native, single-page, or service application. This setting is required to register Okta Identity Providers and not required for other Identity Provider. Please note that Okta overwrites values of the TokenEndpointAuthMethod, GrantType, and ResponseTypes properties and fills them based on the value of the OktaAppType property.

Available options:

web,

native,

browser,

service

ClientTypes.ID

integer

UID of this client type

ClientTypes.CreatedAt

string

Timestamp of when this client type was created

ClientTypes.UpdatedAt

string

Timestamp of when this client type was created

SSLInsecureSkipVerify

boolean

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

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

Get an Identity Provider's data Delete an OAuth2.0 Identity Provider

⌘I

Overview

Getting Started

Publishing APIs

Consuming APIs

User Management

Portal Administration

Reference

Legacy Products

Update an OAuth2.0 Identity Provider

Authorizations

Path Parameters

Body

Response