Organization Services

Path:/organization/v3/services

The Organization Services endpoint provides management of Services belonging to an Organization.

GET

Get all of the Services 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 Organization Service entities with the following attributes:

id (string):Globally unique identifier for the Organization Service
name (string):Name of the Organization Service
active (boolean):Is the Organization Service active
icon (string):URL of icon image for the Organization Service. This will be displayed in the Admin Center and may be displayed in the Mobile Authenticator.
description (string):Description of the Organization Service
callback_url (string):URL to which web hooks for this Organization Service will be made.

Example of the result for an Organization 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 the result for an Organization without Services:

[]

POST

Create a Service under an Organization

Request

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

name (string):Name of the Organization Service. Service names are required to be globally unique. If the name provided is in use by another Directory Service or Organization Service, a 400 Invalid Request response will be returned along with an error body having the error code SVC-001.
active (boolean) [optional]:Is the Organization Service active. Defaults to true.
icon (string) [optional]:URL of icon image for the Organization Service. This will be displayed in the Admin Center and may be displayed in the Mobile Authenticator. Defaults to a generic icon.
description (string) [optional]:Description of the Organization Service. Defaults to null.
callback_url (string) [optional]:URL to which web hooks for this Organization Service will be made. Defaults to null.

Example:

 {
    "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"
}

Response

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

id (string):Identifier of the Organization Service just created

Example:

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

PATCH

Update an Organization Service

Request

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

service_id (string):Identifier of the Organization Service to update
name (string) [optional]:Name of the Organization Service. Service names are required to be globally unique. If the name provided is in use by another Directory Service or Organization Service, a 400 Invalid Request response will be returned along with an error body having the error code SVC-001.
active (boolean) [optional]:Is the Organization Service active.
icon (string) [optional]:URL of icon image for the Organization Service. This will be displayed in the Admin Center and may be displayed in the Mobile Authenticator.
description (string) [optional]:Description of the Organization Service.
callback_url (string) [optional]:URL to which web hooks for this Organization Service will be made.

Example:

 {
    "service_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"
}

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