Jump to

• Request
• Response

Get certificates.

get

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

This operation retrieves certificates.

Request

Path Parameters

• orgId: string
  Organization identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Certificates were successfully retrieved.

Body ()

Root Schema : Certificates

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/Certificate"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Certificate

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

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 : Certificate

Type: object

Show Source

• description(optional): string
  Description of the certificate

  Example: Allows users to work with database
• id(optional): string
  Read Only: true

  The unique id of the object

  Example: 53
• issuer: string
  Minimum Length: 0

  Maximum Length: 255

  Issuer of the certificate, cannot be blank, max length is 255 characters

  Example: Oracle
• links(optional): array links
• reminder: integer(int32)
  Minimum Value: 1

  Number (positive) of days before the certificate expires to send a reminder to the user

  Example: 30
• requiresScan: boolean
  Flag indicating whether the scan needs to be provided before the certificate is considered as valid

  Example: false
• title: string
  Minimum Length: 0

  Maximum Length: 255

  Title of the certificate, cannot be blank, max length is 255 characters

  Example: IT specialist

{
    "required":[
        "issuer",
        "reminder",
        "requiresScan",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "title":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Title of the certificate, cannot be blank, max length is 255 characters",
            "example":"IT specialist"
        },
        "issuer":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Issuer of the certificate, cannot be blank, max length is 255 characters",
            "example":"Oracle"
        },
        "description":{
            "type":"string",
            "description":"Description of the certificate",
            "example":"Allows users to work with database"
        },
        "reminder":{
            "minimum":1,
            "type":"integer",
            "description":"Number (positive) of days before the certificate expires to send a reminder to the user",
            "format":"int32",
            "example":30
        },
        "requiresScan":{
            "type":"boolean",
            "description":"Flag indicating whether the scan needs to be provided before the certificate is considered as valid",
            "example":false
        },
        "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