Directory Public Keys List

Path:/organization/v3/directory/keys/list

This endpoint provides the ability to get a list of all Public Keys for a particular Directory.

POST

Retrieves a list of Public Keys for a Directory.

Request

Requests will be a JWE encrypted JSON payload with the following attribute:

directory_id (string):The ID of the Directory in order to retrieve the Public Keys.

Example:

{"directory_id": "ce5ab88c-e79e-4049-bb36-4f8709122648"}

Response

Responses will be a JWE encrypted JSON payload consisting of an array of Public Key entities with the following attributes:

id (string):The MD5 fingerprint of the public key.
public_key (string):The public key itself.
date_created (string):An ISO-8601 formatted date signifying the time when the public key was added to the Directory.
date_expires (string):An ISO-8601 formatted date signifying the time when the public key expires and is no longer active.
active (boolean):A boolean value that answers: “Is the current public key active?”

Example of result when the Directory has Public Keys:

[
    {
        "id": "e2:f4:14:25:24:45:66:a2:c1:6f:d6:0c:c9:00:09:66",
        "public_key", "-----BEGIN PUBLIC KEY-----
MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD38jQRiR5RffOHDcvU2Qp9X3qy
wKTYV0tKP/OpaA61BvtKudOlE1TUQNSmBBtzKSsVeA2SQ8BAwUF7smQn+uZpT90C
XMXnba7wNu7YfsmBIbjIjQ0M7xRm2z/jzVo0ltKog1RU2/5CY67Zw+wXcW7UuTCC
sv+nCk+H6gDCPl4TYwIDAQAB
-----END PUBLIC KEY-----",
        "date_created": "2010-01-01T00:00:00Z",
        "date_expires": "2020-01-01T00:00:00Z",
        "active": true
    },
    {
        "id": "24:25:f2:b8:ff:df:f7:91:f4:13:68:c8:c9:3c:3a:00",
        "public_key", "-----BEGIN PUBLIC KEY-----
MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDPZUDQtZst7EcssKBmeHqi/kpH
AKfi/yKAe+FSSnstAF5/0j95LYhznN5llj0lkKR4j3XSd3u9tUAc+vktSUETINa+
bCldsCKyFvuF3xAwcQGhXWtCkKEgjYXduVOGJ8Mr9iMWl+x3oZq3FXm9y9M++axO
45I6aK8+Ti0XcqdjvwIDAQAB
-----END PUBLIC KEY-----",
        "date_created": "2010-01-01T00:00:00Z",
        "date_expires": null,
        "active": false
    }
]

Example of result when the Directory has no Public Keys:

[]

Errors

403 Forbidden:If the Directory ID supplied belongs to another Organization than the one identified by the provided credentials, a 403 Forbidden error will be returned.
400 Invalid / DIR-004:If a Directory ID supplied does not exist, a 400 Invalid Request response with the error code DIR-004 will be returned.

User Contributed

LaunchKey links to user contributed code as a resource to its community. LaunchKey does not in any way guarantee or warrant the quality and security of these code bases. User contributed code is supported by the creators. If you do find a link from the site to user contributed code that is malicious or inappropriate in any way, please report that link to LaunchKey immediately and we will investigate the claim. Submit any issue to LaunchKey support at https://launchkey.com./support. ×