Update an OpenID Connect client

cURL

curl --request PUT \
  --url https://api.rownd.io/applications/{app}/oidc-clients/{client} \
  --header 'Content-Type: application/json' \
  --header 'x-rownd-app-key: <api-key>' \
  --header 'x-rownd-app-secret: <api-key>' \
  --data '
{
  "name": "Example OIDC Provider",
  "description": "Example OIDC Provider",
  "config": {
    "allowed_origins": [
      "https://example.com"
    ],
    "redirect_uris": [
      "https://example.com/callback"
    ],
    "post_logout_uris": [
      "https://example.com/logout"
    ],
    "logo_uri": "https://storage.rownd.io/logo-oidc-client-app_1234_oidcc_5667-filename.png",
    "logo_dark_mode_uri": "https://storage.rownd.io/logo-oidc-client-app_1234_oidcc_5667-filename.png",
    "allowed_scopes": [
      "openid",
      "profile",
      "email"
    ],
    "hub_title": "Sign in to My App with Another App",
    "hub_dark_mode": "enabled",
    "hub_show_logos": true,
    "is_pkce_supported": true
  }
}
'

{
  "id": "oidc_client_ck9c1glf0100001l2f7z8z9z9",
  "app_id": "app_ckl8bcf1g000001l2f7z8z9z9",
  "name": "Example OIDC Provider",
  "description": "Example OIDC Provider",
  "config": {
    "allowed_origins": [
      "https://example.com"
    ],
    "redirect_uris": [
      "https://example.com/callback"
    ],
    "post_logout_uris": [
      "https://example.com/logout"
    ],
    "logo_uri": "https://storage.rownd.io/logo-oidc-client-app_1234_oidcc_5667-filename.png",
    "logo_dark_mode_uri": "https://storage.rownd.io/logo-oidc-client-app_1234_oidcc_5667-filename.png",
    "allowed_scopes": [
      "openid",
      "profile",
      "email"
    ],
    "hub_title": "Sign in to My App with Another App",
    "hub_dark_mode": "enabled",
    "hub_show_logos": true,
    "is_pkce_supported": true
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "credentials": [
    {
      "name": "Production API Key",
      "client_id": "<string>",
      "secret": "<string>",
      "expires": "2024-12-31T23:59:59Z",
      "application": "app_k3y1qwerty12345",
      "app_variant_id": "variant_fgy1qw367fty121lm",
      "oidc_client_configuration_id": "oidcc_k3y1qwerty12345",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

PUT

applications

{app}

oidc-clients

{client}

cURL

curl --request PUT \
  --url https://api.rownd.io/applications/{app}/oidc-clients/{client} \
  --header 'Content-Type: application/json' \
  --header 'x-rownd-app-key: <api-key>' \
  --header 'x-rownd-app-secret: <api-key>' \
  --data '
{
  "name": "Example OIDC Provider",
  "description": "Example OIDC Provider",
  "config": {
    "allowed_origins": [
      "https://example.com"
    ],
    "redirect_uris": [
      "https://example.com/callback"
    ],
    "post_logout_uris": [
      "https://example.com/logout"
    ],
    "logo_uri": "https://storage.rownd.io/logo-oidc-client-app_1234_oidcc_5667-filename.png",
    "logo_dark_mode_uri": "https://storage.rownd.io/logo-oidc-client-app_1234_oidcc_5667-filename.png",
    "allowed_scopes": [
      "openid",
      "profile",
      "email"
    ],
    "hub_title": "Sign in to My App with Another App",
    "hub_dark_mode": "enabled",
    "hub_show_logos": true,
    "is_pkce_supported": true
  }
}
'

{
  "id": "oidc_client_ck9c1glf0100001l2f7z8z9z9",
  "app_id": "app_ckl8bcf1g000001l2f7z8z9z9",
  "name": "Example OIDC Provider",
  "description": "Example OIDC Provider",
  "config": {
    "allowed_origins": [
      "https://example.com"
    ],
    "redirect_uris": [
      "https://example.com/callback"
    ],
    "post_logout_uris": [
      "https://example.com/logout"
    ],
    "logo_uri": "https://storage.rownd.io/logo-oidc-client-app_1234_oidcc_5667-filename.png",
    "logo_dark_mode_uri": "https://storage.rownd.io/logo-oidc-client-app_1234_oidcc_5667-filename.png",
    "allowed_scopes": [
      "openid",
      "profile",
      "email"
    ],
    "hub_title": "Sign in to My App with Another App",
    "hub_dark_mode": "enabled",
    "hub_show_logos": true,
    "is_pkce_supported": true
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "credentials": [
    {
      "name": "Production API Key",
      "client_id": "<string>",
      "secret": "<string>",
      "expires": "2024-12-31T23:59:59Z",
      "application": "app_k3y1qwerty12345",
      "app_variant_id": "variant_fgy1qw367fty121lm",
      "oidc_client_configuration_id": "oidcc_k3y1qwerty12345",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

x-rownd-app-key

string

header

required

The publishable key of your application credentials. (more details)

x-rownd-app-secret

string

header

required

The private secret of your application credentials. (more details)

Path Parameters

app

string

required

Rownd application ID

client

string

required

OIDC Client ID

Body

application/json

name

string

Name of the OIDC client

Example:

"Example OIDC Provider"

description

string

Description of the OIDC client

Example:

"Example OIDC Provider"

config

object

Show child attributes

config.allowed_origins

string[]

Allowed origins for the OIDC client

Example:

["https://example.com"]

config.redirect_uris

string[]

Redirect URIs supported by the OIDC client

Example:

["https://example.com/callback"]

config.post_logout_uris

string[]

Post logout URIs for the OIDC client

Example:

["https://example.com/logout"]

config.logo_uri

string

URI of the logo for the OIDC client

Example:

"https://storage.rownd.io/logo-oidc-client-app_1234_oidcc_5667-filename.png"

config.logo_dark_mode_uri

string

URI of the logo for the OIDC client in dark mode

Example:

"https://storage.rownd.io/logo-oidc-client-app_1234_oidcc_5667-filename.png"

config.allowed_scopes

string[]

Scopes supported by the OIDC client

Example:

["openid", "profile", "email"]

config.hub_title

string

Title of the hub

Example:

"Sign in to My App with Another App"

config.hub_dark_mode

enum<string>

Dark mode setting for the hub

Available options:

enabled,

disabled,

auto

Example:

"enabled"

config.hub_show_logos

boolean

Whether to show the logos in the hub

Example:

true

config.is_pkce_supported

boolean

Whether PKCE is supported for the OIDC client

Example:

true

Response

200 - application/json

OIDC client updated successfully

string

Unique identifier for the OIDC client

Example:

"oidc_client_ck9c1glf0100001l2f7z8z9z9"

app_id

string

Application identifier associated with the OIDC client

Example:

"app_ckl8bcf1g000001l2f7z8z9z9"

name

string

Name of the OIDC client

Example:

"Example OIDC Provider"

description

string

Description of the OIDC client

Example:

"Example OIDC Provider"

config

object

Show child attributes

config.allowed_origins

string[]

Allowed origins for the OIDC client

Example:

["https://example.com"]

config.redirect_uris

string[]

Redirect URIs supported by the OIDC client

Example:

["https://example.com/callback"]

config.post_logout_uris

string[]

Post logout URIs for the OIDC client

Example:

["https://example.com/logout"]

config.logo_uri

string

URI of the logo for the OIDC client

Example:

"https://storage.rownd.io/logo-oidc-client-app_1234_oidcc_5667-filename.png"

config.logo_dark_mode_uri

string

URI of the logo for the OIDC client in dark mode

Example:

"https://storage.rownd.io/logo-oidc-client-app_1234_oidcc_5667-filename.png"

config.allowed_scopes

string[]

Scopes supported by the OIDC client

Example:

["openid", "profile", "email"]

config.hub_title

string

Title of the hub

Example:

"Sign in to My App with Another App"

config.hub_dark_mode

enum<string>

Dark mode setting for the hub

Available options:

enabled,

disabled,

auto

Example:

"enabled"

config.hub_show_logos

boolean

Whether to show the logos in the hub

Example:

true

config.is_pkce_supported

boolean

Whether PKCE is supported for the OIDC client

Example:

true

created_at

string<date-time>

The ISO 8601 date-time that the resource was created

updated_at

string<date-time>

The ISO 8601 date-time that the resource was updated

credentials

object[]

Credentials associated with the OIDC client

Show child attributes

credentials.name

string

required

Name of the application credential

Example:

"Production API Key"

credentials.client_id

string

Unique identifier for the credential

credentials.secret

string

Secret key used for authentication

credentials.expires

string<date-time>

Expiration date and time of the credential

Example:

"2024-12-31T23:59:59Z"

credentials.application

string

ID of the application this credential belongs to

Example:

"app_k3y1qwerty12345"

credentials.app_variant_id

string

ID of the application variant

Example:

"variant_fgy1qw367fty121lm"

credentials.oidc_client_configuration_id

string

ID of the OIDC client configuration

Example:

"oidcc_k3y1qwerty12345"

credentials.created_at

string<date-time>

The ISO 8601 date-time that the resource was created

credentials.updated_at

string<date-time>

The ISO 8601 date-time that the resource was updated

Retrieve an OpenID Connect client Delete an OpenID Connect client

⌘I

Get Started

App-Scoped Endpoints

User-Scoped Endpoints

Update an OpenID Connect client

Authorizations

Path Parameters

Body

Response