List OpenID Connect clients

GET

applications

{app}

oidc-clients

curl --request GET \
  --url https://api.rownd.io/applications/{app}/oidc-clients \
  --header 'x-rownd-app-key: <api-key>' \
  --header 'x-rownd-app-secret: <api-key>'

{
  "total_results": 123,
  "results": [
    {
      "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

Query Parameters

page_size

integer

Number of resources to return per query. Max is 1000.

after

string

ID of the last resource in the previous page. If provided, the next page of results is returned beginning with this resource ID.

sort

enum<string>

Which direction to sort the results

Available options:

asc,

desc

Response

200 - application/json

OIDC clients retrieved successfully

total_results

integer

results

object[]

results.id

string

Unique identifier for the OIDC client

Example:

"oidc_client_ck9c1glf0100001l2f7z8z9z9"

results.app_id

string

Application identifier associated with the OIDC client

Example:

"app_ckl8bcf1g000001l2f7z8z9z9"

results.name

string

Name of the OIDC client

Example:

"Example OIDC Provider"

results.description

string

Description of the OIDC client

Example:

"Example OIDC Provider"

results.config

object

results.config.allowed_origins

string[]

Allowed origins for the OIDC client

Example:

["https://example.com"]

results.config.redirect_uris

string[]

Redirect URIs supported by the OIDC client

Example:

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

results.config.post_logout_uris

string[]

Post logout URIs for the OIDC client

Example:

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

results.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"

results.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"

results.config.allowed_scopes

string[]

Scopes supported by the OIDC client

Example:

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

results.config.hub_title

string

Title of the hub

Example:

"Sign in to My App with Another App"

results.config.hub_dark_mode

enum<string>

Dark mode setting for the hub

Available options:

enabled,

disabled,

auto

Example:

"enabled"

results.config.hub_show_logos

boolean

Whether to show the logos in the hub

Example:

true

results.config.is_pkce_supported

boolean

Whether PKCE is supported for the OIDC client

Example:

true

results.created_at

string

The ISO 8601 date-time that the resource was created

results.updated_at

string

The ISO 8601 date-time that the resource was updated

results.credentials

object[]

Credentials associated with the OIDC client

Create a magic link Create an OpenID Connect client

curl --request GET \
  --url https://api.rownd.io/applications/{app}/oidc-clients \
  --header 'x-rownd-app-key: <api-key>' \
  --header 'x-rownd-app-secret: <api-key>'

{
  "total_results": 123,
  "results": [
    {
      "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"
        }
      ]
    }
  ]
}

Get Started

App-Scoped Endpoints

User-Scoped Endpoints

List OpenID Connect clients

Authorizations

Path Parameters

Query Parameters

Response