Directory SDK Keys

Path:/organization/v3/directory/sdk-keys

Endpoint for managing Mobile Authenticator SDK Keys for a particular Directory

POST

Generate a new Mobile Authenticator SDK Key, associate it with the provided directory, and return the value

Request

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

directory_id (string):Directory Identifier of the Directory for which you wish to generate a Mobile Authenticator SDK Key

Example:

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

Response

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

sdk_key (string):

The newly generated Authenticator SDK Key for the Directory whose ID was provided

Example:

{"sdk_key": "829c2ec9-d0cb-44bf-b092-14ae58baaa48"}

DELETE

Remove an existing Mobile Authenticator SDK Key from a Directory

Request

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

directory_id (string):Directory Identifier of the Directory from which you wish to delete a Mobile Authenticator SDK Key
sdk_key (string):Mobile Authenticator SDK Key you wish to delete

Example:

{
    "directory_id": "ce5ab88c-e79e-4049-bb36-4f8709122648",
    "sdk_key": "829c2ec9-d0cb-44bf-b092-14ae58baaa48"
}

Response

There is no response data.

Errors

If the SDK is the only Mobile Authenticator SDK Key for the Directory, you will receive a 400 Invalid Request response with the error code ORG-005.

If the SDK Key provided does not exists for the provided Directory ID, you will receive a 400 Invalid Request response with the error code ORG-006.

If a Directory ID supplied does not exist, you will receive a 400 Invalid Request response with the error code DIR-004.

If the Directory ID supplied belongs to another Organization than the one identified by the provided credentials, a 403 Forbidden response 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. ×