POST /api/v1/apps/{appId}/credentials/csrs
Generates a new key pair and returns the Certificate Signing Request(CSR) for it. The information in a CSR is used by the Certificate Authority (CA) to verify and create your certificate. It also contains the public key that is included in your certificate.
Returns CSR in pkcs#10
format if the Accept
media type is application/pkcs10
or a CSR object if the Accept
media type is application/json
.
Note: The key pair isn't listed in the Key Credentials for the app until it's published.
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 |
---|---|---|---|
subjectAltNames |
Object | No | |
subjectAltNames.dnsNames[] |
Array | No |
DNS names of the subject |
subject |
Object | No | |
subject.stateOrProvinceName |
String | No |
State or province name |
subject.organizationName |
String | No |
Large organization name |
subject.organizationalUnitName |
String | No |
Name of the smaller organization, for example, the department or the division |
subject.commonName |
String | No |
Common name of the subject |
subject.countryName |
String | No |
Country name or code |
subject.localityName |
String | No |
Locality (city) name |
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.