Directories

Path:/organization/v3/directories

The directories endpoint provides management of Directories belonging to an Organization.

GET

Get all of the Directories that belong to an Organization

Request

The request has no body or query parameters.

Response

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

id (string):Globally unique identifier for the Directory
name (string):Name of the Directory
active (boolean):Is the Directory active
premium (boolean):Unused at this time
service_ids (string[]):Array of Service IDs for the Directory
sdk_keys (string[]):Array of Authenticator SDK Keys for the Directory. Authenticator SDK Keys are utilized by Mobile Authenticators when linking User Devices to a Directory
android_key (string):Key used for communicating with Android based push notification services on behalf of this Directory
ios_certificate_fingerprint (string):Fingerprint of the Certificate for communicating with iOS based push notification services on behalf of the Directory

Example of the result for an Organization with Directories:

[
    {
        "id": "ce5ab88c-e79e-4049-bb36-4f8709122648",
        "name": "Directory One",
        "active": true,
        "premium": true,
        "service_ids": ["ea6c2394-819c-4f09-9110-3a28a2f92699", "09d974c1-d0ef-4de4-b34d-abec8a113a7d"],
        "sdk_keys": ["4abce20a-3cf8-40a5-bff2-418d6945c404"],
        "android_key": "2349872039AE0923DF4",
        "ios_certificate_fingerprint": "ca:86:58:c6:f9:f5:b1:88:7b:dd:da:cc:74:e5:63:ed:78:b1:38:23:7d:6c:48:f9:71:9b:63:1b:ba:60:1d:97"
    },
    {
        "id": "b11869ab-ceb3-417e-a5ba-ca403e678f12",
        "name": "Directory 2",
        "active": false,
        "premium": true,
        "service_ids": [],
        "sdk_keys": [],
        "android_key": null,
        "ios_certificate_fingerprint": null
    }
]

Example of the result for an Organization without Directories:

[]

POST

Create a Directory under an Organization

Request

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

name (string):Name you wish to give the Directory. Directory names are required to be unique within an Organization. If the name provided is in use by another Directory for the same Organization, a 400 Invalid Request response will be returned along with an error body having the error code ORG-003.

Example:

{"name": "Directory One"}

Response

Responses will be a JWE encrypted JSON payload consisting of the identifier of the Directory just created.

id (string):Identifier of the Directory just created

Example:

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

PATCH

Update a Directory

Request

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

directory_id (string):Identifier for the Directory
active (boolean) [optional]:Active status of the Directory
android_key (string) [optional]:Key used for communicating with Android based push notification services on behalf of this Directory
ios_p12 (string) [optional]:PKCS #12 formatted key and certificate for communicating with iOS based push notification services on behalf of the Directory

Example:

{
     "directory_id": "ce5ab88c-e79e-4049-bb36-4f8709122648",
     "active": true,
     "android_key": "2349872039AE0923DF4",
     "ios_p12": "this_would_be_a_valid_iOS_p12_formatted_key_and_certificate"
 }

Response

There is no response data.

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. ×