Directory SDK Keys

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

This endpoint manages Mobile Authenticator SDK Keys for a particular Directory.

POST

Generates a new Mobile Authenticator SDK Key, associates it with the provided directory, and returns the value.

Request

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

directory_id (string):The Directory Identifier of the Directory in order 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 attribute:

sdk_key (string):

The newly generated Authenticator SDK Key for the provided Directory.

Example:

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

DELETE

Removes 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):The Directory Identifier of the Directory in order to delete a Mobile Authenticator SDK Key.
sdk_key (string):The Mobile Authenticator SDK Key to delete.

Example:

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

Response

There is no response data.

Errors

400 Invalid / ORG-005:If the SDK is the only Mobile Authenticator SDK Key for the Directory, a 400 Invalid Request response with the error code ORG-005 will be returned.
400 Invalid / ORG-006:If the SDK Key provided does not exists for the provided Directory ID, a 400 Invalid Request response with the error code ORG-006 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.
403 Forbidden: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. ×