POST /api/v1/apps/{appId}/credentials/jwks
Adds a new JSON Web Key to the client’s JSON Web Keys.
Note: This API doesn't allow you to add a key if the existing key doesn't have a
kid
. This is also consistent with how the Dynamic Client Registration or Applications APIs behave, as they don't allow the creation of multiple keys withoutkids
. Use the Replace an Application or the Replace a Client Application operation to update the JWKS or Delete an OAuth 2.0 Client JSON Web Key and re-add the key with akid
.
Servers
- https://{yourOktaDomain}
Path parameters
Name | Type | Required | Description |
---|---|---|---|
appId |
String | Yes |
Application ID |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
alg |
String | No |
Algorithm used in the key |
n |
String | No |
RSA key value (modulus) for key binding |
kty |
String | No |
Cryptographic algorithm family for the certificate's key pair |
e |
String | No |
RSA key value (exponent) for key binding |
kid |
String | No |
Unique identifier of the JSON Web Key in the OAUth 2.0 Client's JWKS |
status |
String | No |
Status of the OAuth 2.0 Client JSON Web Key Possible values:
|
use |
String | No |
Acceptable use of the JSON Web Key |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.