Jump to

• Request
• Response

Get certificate type - certificate associations.

get

/connectedWorker/clientapi/v2/orgs/{orgId}/certificateTypes/{certificateTypeId}/certificates

This operation retrieves certificate type - certificate associations.

Request

Path Parameters

• certificateTypeId: string
  Certificate type identifier
• orgId: string
  Organization identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Certificate type - certificate associations were successfully retrieved.

Body ()

Root Schema : CertificateTypeCertificates

Type: object

Show Source

• items: array items
• links(optional): array links
  Read Only: true

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CertificateTypeCertificate"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object CertificateTypeCertificate

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CertificateTypeCertificate"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : CertificateTypeCertificate

Type: object

Show Source

• certificateId: string
  Id of the certificate which will be associated with the certificate type

  Example: 321
• certificateTypeId: string
  Id of the certificate type to which the certificate is associated

  Example: 123
• links(optional): array links

{
    "required":[
        "certificateId",
        "certificateTypeId"
    ],
    "type":"object",
    "properties":{
        "certificateTypeId":{
            "type":"string",
            "description":"Id of the certificate type to which the certificate is associated",
            "example":"123"
        },
        "certificateId":{
            "type":"string",
            "description":"Id of the certificate which will be associated with the certificate type",
            "example":"321"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top