REST API for OAuth in Oracle Access Manager

Add a new trust certificate for client authentication

post

/oam/services/rest/ssa/api/v1/security/trust/oauthClient/certificate

Request

Supported Media Types

application/json

Trust certificate needed for client authentication

Root Schema : ClientTrustCertificateRequest

Type: object

Show Source

id(required): string

certificate ID
publicCert(required): string

base64 encoded certificate value excluding --BEGIN CERTIFICATE-- and --- END CERTIFICATE--- tags.

{
    "type":"object",
    "required":[
        "publicCert",
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"certificate ID"
        },
        "publicCert":{
            "type":"string",
            "description":"base64 encoded certificate value excluding --BEGIN CERTIFICATE-- and --- END CERTIFICATE--- tags."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : ClientTrustCertificateResponse

Type: object

Show Source

message: string

sucess or failure message
response: object ClientTrustCertificate
status: string

HTTP response code

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "status":{
            "type":"string",
            "description":"HTTP response code"
        },
        "message":{
            "type":"string",
            "description":"sucess or failure message"
        },
        "response":{
            "$ref":"#/definitions/ClientTrustCertificate"
        }
    }
}

Nested Schema : ClientTrustCertificate

Type: object

Show Source

id(required): string

id of the certificate
issuerDN: string

DN of the issuer of the certificate
notAfter: integer

not afetr value of the certificate in milliseconds after 1970
notBefore: integer

not before value of the certificate in milliseconds after 1970
publicCert(required): string

Base64 encoded certificate value
subject: string

Subject DN value of the certificate
x5t: string

sha256 hash value of the certificate

{
    "type":"object",
    "required":[
        "publicCert",
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the certificate"
        },
        "publicCert":{
            "type":"string",
            "description":"Base64 encoded certificate value"
        },
        "x5t":{
            "type":"string",
            "description":"sha256 hash value of the certificate"
        },
        "issuerDN":{
            "type":"string",
            "description":"DN of the issuer of the certificate"
        },
        "subject":{
            "type":"string",
            "description":"Subject DN value of the certificate"
        },
        "notBefore":{
            "type":"integer",
            "description":"not before value of the certificate in milliseconds after 1970"
        },
        "notAfter":{
            "type":"integer",
            "description":"not afetr value of the certificate in milliseconds after 1970"
        }
    }
}

422 Response

Failed to create the certificate entry. Invalid input/Certificate store operation failed.

Examples

cURL Sample Request

curl --location --request POST 'https://<admin-host>:<admin-port>/oam/services/rest/ssa/api/v1/security/trust/oauthClient/certificate' \
--header 'Accept: application/json' \
--header 'Authorization: Basic dGVzdDp0ZXN0=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "publicCert": "MIIF3jCCA8agAwIBAgIJAPDbeYrRdWaVMA0GCSqGSIb3DQEBCwUAMHwxCzAJBgNVBAYTAklOMQswCQYDVQQIDAJLQTEMMAoGA1UEBwwDQkxSMQ8wDQYDVQQKDAZPcmFjbGUxDDAKBgNVBAsMA09BTTEQMA4GA1UEAwwHc2VydmVyMTEhMB8GCSqGSIb3DQEJARYSc2VydmVyMUBvcmFjbGUuY29tMB4XDTIxMDgxOTEwMzc0NVoXDTQxMDgxNDEwMzc0NVowfDELMAkGA1UEBhMCSU4xCzAJBgNVBAgMAktBMQwwCgYDVQQHDANCTFIxDzANBgNVBAoMBk9yYWNsZTEMMAoGA1UECwwDT0FNMRAwDgYDVQQDDAdzZXJ2ZXIxMSEwHwYJKoZIhvcNAQkBFhJzZXJ2ZXIxQG9yYWNsZS5jb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDg0sEo+7+j9Gd+Ju5X2HQFvKHSJZ7RzFs/iPeTQqPWo9c77MmZb3ldaK/dya1JToJVwf6SYkdXvM1bskemRsNE5+4jKEBzN3ZD68StD6MwWAtRs8XSgC4lTid/+Lzr7uy0eTAA2CM0to+Ytrr84p0fRpUyt6kdvpCOeRWtp/8sOcOLnMXz3RgrBxbAGzi5Ne0PDCJ9wdqomo7o+4i9xZlTep7/gGqtMsTurW1ytv/dkcA2dWQE4K3IUn5IgVcJVWxOwYcKAzH4gO4kyhIJH7YxritfzM7BIDpxNQKuFvnSgQfyL1WyKSvSpK+TdSr4kGaHLt6SfM0ezaDLXGlBtrK3w8P8MgUzkILs9/EmnDVh8Qz9KD2q6jq8tBml+NHA3dv+PfnZrWq4N/DB0ss9sgPw/bO7PUWk35IGpVAMWX7SottWXw9gsxidOXE2rmIP/A580f9LxVpS0MFKlO+h5RtmhacfkyU+YDKI/BrPA945Yu4hcwmb/uTuIkPI4lJdYW0LAkcTL2HUawBnzGudIf34FkUlPxBGvdG1zrprk5UvWsZEQwAEnehzsvBVxQq24TIW4h7Fr4fmy3j+GuCfC1eA8eMP5NGQNRMzoSM+5cWANUk7cNLfXWyg3g8k1Ze+PI+uAbViq0dpbSFMguQxoOhbvW0SXRE9f3+ROE5q5BOlpQIDAQABo2MwYTAdBgNVHQ4EFgQUvGdmku8uGkzUAiY3rToZ+NYDv08wHwYDVR0jBBgwFoAUvGdmku8uGkzUAiY3rToZ+NYDv08wDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIBADX+YQUnnTZcoJbGz2WGLsDGEbvJJ7mQkQlJtB+5szWGEnOzgi6IrK/qc+PtgquLRqrkRr1vOvspZK0/4qqs+6Eq/FquWmAUSp8YjhN0NGMk45/T8awaERdNWg4NOTYYHNP26rf2/jhnBTKJ1leBcwlHBMXzV3rMrPbioXElGU38KOlPtNG97dHaIAsk1UQRajGtmbmLvrPGUMuVz+ukmGExe8oSbkDQKxF/f7cmdVNtCZbNIB2kOe/h+1BvDOfLlrgtIIcaRp96S9m0XwgteLcyKP8kz2zm3PnpAx4A4GlKRWmkuXRgahquaNzcxyXFZ5KqVIGCtI/GIadWn4PWnQW0rWOWrGjOUcmTHmhNc3j+tnflxmvcIknE45xuuBtgbVF3f+Yeyzr+snlrDA2EOf22KGzCPOAwk3LIRg0p1TLtWtYvJrAmHxIPnoVizszco0C+vjCnv3BTVrb+Iayx59ztYF1iSGaq7iP9bog0yGl6u/mWk++4OxVIK9y93Goy5RHEiBzcWbSOCNz8u2l42TMmwx3YY8lpDWbTSHRNd2CQ0LzGOpibppIMH8AKUchniZv8O/xkWfoejb6ydqZiRfNNw6S74hxmdVdhtWuGDt/Uh+i+bCxfsZmBNt/01i1rDsN79ZQgBMe0Dt/nbfy28Ob67a1G6QKS4/LOf1d9Tc7F",
    "id": "ClientMTLS12"
}'

cURL Sample Response

{
    "status": "200",
    "message": "created",
    "response": {
        "publicCert": "MIIF3jCCA8agAwIBAgIJAPDbeYrRdWaVMA0GCSqGSIb3DQEBCwUAMHwxCzAJBgNVBAYTAklOMQswCQYDVQQIDAJLQTEMMAoGA1UEBwwDQkxSMQ8wDQYDVQQKDAZPcmFjbGUxDDAKBgNVBAsMA09BTTEQMA4GA1UEAwwHc2VydmVyMTEhMB8GCSqGSIb3DQEJARYSc2VydmVyMUBvcmFjbGUuY29tMB4XDTIxMDgxOTEwMzc0NVoXDTQxMDgxNDEwMzc0NVowfDELMAkGA1UEBhMCSU4xCzAJBgNVBAgMAktBMQwwCgYDVQQHDANCTFIxDzANBgNVBAoMBk9yYWNsZTEMMAoGA1UECwwDT0FNMRAwDgYDVQQDDAdzZXJ2ZXIxMSEwHwYJKoZIhvcNAQkBFhJzZXJ2ZXIxQG9yYWNsZS5jb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDg0sEo+7+j9Gd+Ju5X2HQFvKHSJZ7RzFs/iPeTQqPWo9c77MmZb3ldaK/dya1JToJVwf6SYkdXvM1bskemRsNE5+4jKEBzN3ZD68StD6MwWAtRs8XSgC4lTid/+Lzr7uy0eTAA2CM0to+Ytrr84p0fRpUyt6kdvpCOeRWtp/8sOcOLnMXz3RgrBxbAGzi5Ne0PDCJ9wdqomo7o+4i9xZlTep7/gGqtMsTurW1ytv/dkcA2dWQE4K3IUn5IgVcJVWxOwYcKAzH4gO4kyhIJH7YxritfzM7BIDpxNQKuFvnSgQfyL1WyKSvSpK+TdSr4kGaHLt6SfM0ezaDLXGlBtrK3w8P8MgUzkILs9/EmnDVh8Qz9KD2q6jq8tBml+NHA3dv+PfnZrWq4N/DB0ss9sgPw/bO7PUWk35IGpVAMWX7SottWXw9gsxidOXE2rmIP/A580f9LxVpS0MFKlO+h5RtmhacfkyU+YDKI/BrPA945Yu4hcwmb/uTuIkPI4lJdYW0LAkcTL2HUawBnzGudIf34FkUlPxBGvdG1zrprk5UvWsZEQwAEnehzsvBVxQq24TIW4h7Fr4fmy3j+GuCfC1eA8eMP5NGQNRMzoSM+5cWANUk7cNLfXWyg3g8k1Ze+PI+uAbViq0dpbSFMguQxoOhbvW0SXRE9f3+ROE5q5BOlpQIDAQABo2MwYTAdBgNVHQ4EFgQUvGdmku8uGkzUAiY3rToZ+NYDv08wHwYDVR0jBBgwFoAUvGdmku8uGkzUAiY3rToZ+NYDv08wDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIBADX+YQUnnTZcoJbGz2WGLsDGEbvJJ7mQkQlJtB+5szWGEnOzgi6IrK/qc+PtgquLRqrkRr1vOvspZK0/4qqs+6Eq/FquWmAUSp8YjhN0NGMk45/T8awaERdNWg4NOTYYHNP26rf2/jhnBTKJ1leBcwlHBMXzV3rMrPbioXElGU38KOlPtNG97dHaIAsk1UQRajGtmbmLvrPGUMuVz+ukmGExe8oSbkDQKxF/f7cmdVNtCZbNIB2kOe/h+1BvDOfLlrgtIIcaRp96S9m0XwgteLcyKP8kz2zm3PnpAx4A4GlKRWmkuXRgahquaNzcxyXFZ5KqVIGCtI/GIadWn4PWnQW0rWOWrGjOUcmTHmhNc3j+tnflxmvcIknE45xuuBtgbVF3f+Yeyzr+snlrDA2EOf22KGzCPOAwk3LIRg0p1TLtWtYvJrAmHxIPnoVizszco0C+vjCnv3BTVrb+Iayx59ztYF1iSGaq7iP9bog0yGl6u/mWk++4OxVIK9y93Goy5RHEiBzcWbSOCNz8u2l42TMmwx3YY8lpDWbTSHRNd2CQ0LzGOpibppIMH8AKUchniZv8O/xkWfoejb6ydqZiRfNNw6S74hxmdVdhtWuGDt/Uh+i+bCxfsZmBNt/01i1rDsN79ZQgBMe0Dt/nbfy28Ob67a1G6QKS4/LOf1d9Tc7F",
        "privateKey": null,
        "x5t": "xz5ixwwi8fpbcdolxmd6erqbm_uhmyhfe1dowfvwhri",
        "identityDomainName": null,
        "clientName": null,
        "issuerDN": "EMAILADDRESS=server1@oracle.com, CN=server1, OU=OAM, O=Oracle, L=BLR, ST=KA, C=IN",
        "subject": "EMAILADDRESS=server1@oracle.com, CN=server1, OU=OAM, O=Oracle, L=BLR, ST=KA, C=IN",
        "notBefore": 1629369465000,
        "notAfter": 2260089465000,
        "certificateValue": null,
        "validInput": true,
        "id": "ClientMTLS12"
    }
}