Directory Services List

Path:/directory/v3/services/list

This endpoint provides the ability to get a list of specific Services for a particular Directory.

POST

Retrieves a partial list of Services for a Directory.

Request

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

service_ids (string[]):An array of Identifiers of the Directory Services to retrieve.

Example:

{"service_ids": ["ce5ab88c-e79e-4049-bb36-4f8709122648", "b11869ab-ceb3-417e-a5ba-ca403e678f12"]}

Response

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

id (string):The globally unique identifier for the Directory Service.
name (string):The name of the Directory Service.
active (boolean):A boolean value that answers: “Is the Directory Service active?”
icon (string):The URL of icon image for the Directory Service. This will be displayed in the Admin Center and may be displayed in the Mobile Authenticator.
description (string):The description of the Directory Service.
callback_url (string):The URL to which web hooks for this Directory Service will be made.

Example of the result for a Directory with Services:

[
    {
        "id": "ce5ab88c-e79e-4049-bb36-4f8709122648",
        "name": "Service One",
        "active": true,
        "icon": "https://admin.launchkey.com/static/images/service-one-icon.png",
        "description": "Service One Description",
        "callback_url": "https://admin.launchkey.com/webhooks/callback"
    },
    {
        "id": "b11869ab-ceb3-417e-a5ba-ca403e678f12",
        "name": "Service 2",
        "active": false,
        "icon" : null,
        "description" : null,
        "callback_url" : null
    }
]

Example of Directory Services not found for the provided identifiers:

[]

Errors

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