Jump to

• Request
• Response
• Examples

Get a KeyPair or list of KeyPairs

get

/oam/services/rest/ssa/api/v1/keypairadmin/keypair

Returns a KeyPair by aliasName or KeyPairs by days to expire or all the KeyPair

Request

Supported Media Types

• application/json
• application/x-www-form-urlencoded

Query Parameters

• aliasName: string
  Alias Name of the KeyPair to be retrieved.
• expiryDays: string
  Retrieves a KeyPair or list of KeyPairs that will expire within the given number of days.

Back to Top

Response

Supported Media Types

• text/plain
• application/json

200 Response

Body ()

Root Schema : KeyPairArtifacts

Type: array

Show Source

• Array of: object KeyPairArtifactObject
  KeyPair artifact details

{
    "type":"array",
    "xml":{
        "name":"KeyPairArtifacts",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/KeyPairArtifactObject"
    }
}

Nested Schema : KeyPairArtifactObject

Type: object

KeyPair artifact details

Show Source

• aliasName: string
  Alias Name of the KeyPair
• domains: string
  OAuth Identity Domains that are currently making use of the KeyPair
• expiry: string
  Expiry date of the KeyPair
• issuedOn: string
  Date of issuance of the KeyPair
• issuer: string
  Name of the issuer of the KeyPair
• publicKeyDetails: string
  Additional details of the KeyPair
• subjectDN: string
  subjectDN of the KeyPair

{
    "type":"object",
    "description":"KeyPair artifact details",
    "properties":{
        "aliasName":{
            "type":"string",
            "description":"Alias Name of the KeyPair"
        },
        "subjectDN":{
            "type":"string",
            "description":"subjectDN of the KeyPair"
        },
        "issuer":{
            "type":"string",
            "description":"Name of the issuer of the KeyPair"
        },
        "expiry":{
            "type":"string",
            "description":"Expiry date of the KeyPair"
        },
        "issuedOn":{
            "type":"string",
            "description":"Date of issuance of the KeyPair"
        },
        "publicKeyDetails":{
            "type":"string",
            "description":"Additional details of the KeyPair"
        },
        "domains":{
            "type":"string",
            "description":"OAuth Identity Domains that are currently making use of the KeyPair"
        }
    }
}

400 Response

Retrieval failed for NameOfKeyPair. Exception encountered during KeyPair fetch NameOfKeyPair Exception: NameOfKeyPair not found

Back to Top

Examples

cURL Sample Request 1

curl--location--request GET 'https://<admin-host>:<admin-port>/oam/services/rest/ssa/api/v1/keypairadmin/keypair?aliasName=NewDomain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dGVzdDp0ZXN0='

cURL Sample Response 1

[
    {
        "aliasName": "NewDomain",
        "subjectDN": "CN=BadSSL Client Certificate, O=BadSSL, L=San Francisco, ST=California, C=US",
        "issuer": "CN=BadSSL Client Root Certificate Authority, O=BadSSL, L=San Francisco, ST=California, C=US",
        "expiry": "Thu Nov 25 16:19:57 PST 2021",
        "issuedOn": "Tue Nov 26 16:19:57 PST 2019",
        "publicKeyDetails": "Sun RSA public key, 2048 bits",
        "domains": ""
    }
]

cURL Sample Request 2

curl --location --request GET 'https://<admin-host>:<admin-port>/oam/services/rest/ssa/api/v1/keypairadmin/keypair' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic dGVzdDp0ZXN0='

cURL Sample Response 2

[
    {
        "aliasName": "NewDomain1",
        "subjectDN": "EMAILADDRESS=[e-mail], CN=testbox.acme.com, OU=TEST CA, O=acme GmbH, L=Munich, ST=Bavaria, C=DE",
        "issuer": "EMAILADDRESS=[e-mail], CN=x.acme.com, OU=DEMO-CA, O=acme GmbH, L=Munich, ST=Bavaria, C=DE",
        "expiry": "Fri Oct 21 04:08:42 PDT 2022",
        "issuedOn": "Sun Oct 22 04:08:42 PDT 2017",
        "publicKeyDetails": "Sun RSA public key, 2048 bits",
        "domains": ""
    },
    {
        "aliasName": "NewDomain",
        "subjectDN": "CN=BadSSL Client Certificate, O=BadSSL, L=San Francisco, ST=California, C=US",
        "issuer": "CN=BadSSL Client Root Certificate Authority, O=BadSSL, L=San Francisco, ST=California, C=US",
        "expiry": "Thu Nov 25 16:19:57 PST 2021",
        "issuedOn": "Tue Nov 26 16:19:57 PST 2019",
        "publicKeyDetails": "Sun RSA public key, 2048 bits",
        "domains": "ID1"
    }
]

Back to Top