Powered by Smile CDR v2025.02.PRE
Showing documentation for 2025.02.PRE
On this page:
   36.7    OpenID Connect Clients Endpoint
  • JSON Admin Endpoints
  • 36.0 JSON Admin API
  • 36.1 Audit Log Endpoint
  • 36.2 Batch Job Endpoint
  • 36.3 Bulk Import Endpoint
  • 36.4 CDA Exchange Endpoint
  • 36.5 Metrics Endpoint
  • 36.6 Module Config Endpoint
  • 36.7 OpenID Connect Clients Endpoint
  • 36.8 OpenID Connect Keystores Endpoint
  • 36.9 OpenID Connect Servers Endpoint
  • 36.10 OpenID Connect Sessions Endpoint
  • 36.11 Runtime Status Endpoint
  • 36.12 System Config Endpoint
  • 36.13 Transaction Log Endpoint
  • 36.14 Troubleshooting Log Endpoint
  • 36.15 User Management Endpoint
    • 36.9    OpenID Connect Servers Endpoint   
       Table of Contents

    OpenID Connect Keystores Endpoint

    36.8.1OpenID Connect Keystores Endpoint

     

    The OpenID Connect Keystores Endpoint can be used to create, read, and update OIDC keystore definitions that are stored in Smile CDR.

    36.8.2Fetch All OpenID Connect Keystore Definitions

     
    This method requires the OPENID_CONNECT_MANAGE_KEYSTORES permission.

    This method will fetch all keystores stored in the system.


    Request:

    GET http://localhost:9000/keystores/

    You may also add the following URL parameters:

    • pageIndex=[index] – The index of the page to return to the user (0 is the first page)
    • pageSize=[size] – The size of the page to return to the user (e.g. 100)

    Response:

    This operation returns a JSON document object of type OAuth2Keystores. This object will then contain individual definitions of the type OAuth2Keystore.

    Note that actual keystore keys are hidden in response objects. Only the keystore ID and the file path (if present) will be returned.

    Example:

    {
  "keystores": [
    {
      "keystoreId": "default-keystore",
      "filePath": "classpath:/smilecdr-demo.jwks"
    }
  ]
}

    36.8.3Fetch OpenID Connect Keystore Definition by ID

     
    This method requires the OPENID_CONNECT_MANAGE_KEYSTORES permission.

    This method will fetch a single keystore stored in the system.


    Request:

    GET http://localhost:9000/kaystores/[keystore_id]

    Response:

    This operation returns a JSON document object of type OAuth2Keystore.

    Note that actual keystore keys are hidden in response objects. Only the keystore ID and the file path (if present) will be returned.

    36.8.4Create OpenID Connect Keystore Definition

     
    This method requires the OPENID_CONNECT_MANAGE_KEYSTORES permission.

    This method will create a new keystore definition.


    Request:

    POST http://localhost:9000/keystores/

    This operation accepts a JSON document object of type OAuth2Keystore. Example:

    {
	"keystoreId": "default-keystore",
	"filePath": "classpath:/smilecdr-demo.jwks"
}

    36.8.5Update OpenID Connect Keystore Definition

     
    This method requires the OPENID_CONNECT_MANAGE_KEYSTORES permission.

    This method update an existing server definition.


    Request:

    PUT http://localhost:9000/keystores/[keystore_id]

    This operation accepts a JSON document object of type OAuth2Keystore. Example:

    {
	"keystoreId": "default-keystore",
	"filePath": "classpath:/smilecdr-demo.jwks"
}
       36.7    OpenID Connect Clients Endpoint
  • JSON Admin Endpoints
  • 36.0 JSON Admin API
  • 36.1 Audit Log Endpoint
  • 36.2 Batch Job Endpoint
  • 36.3 Bulk Import Endpoint
  • 36.4 CDA Exchange Endpoint
  • 36.5 Metrics Endpoint
  • 36.6 Module Config Endpoint
  • 36.7 OpenID Connect Clients Endpoint
  • 36.8 OpenID Connect Keystores Endpoint
  • 36.9 OpenID Connect Servers Endpoint
  • 36.10 OpenID Connect Sessions Endpoint
  • 36.11 Runtime Status Endpoint
  • 36.12 System Config Endpoint
  • 36.13 Transaction Log Endpoint
  • 36.14 Troubleshooting Log Endpoint
  • 36.15 User Management Endpoint
    • 36.9    OpenID Connect Servers Endpoint