View on GitHub

ickstream-docs

Public documentation about the ickStream Music Platform

Find available authentication providers which can be used to login/register a new user account

Request:

{
    "jsonrpc": 2.0,
    "id": < A unique number used to correlate requests with responses, see JSON-RPC specification for more information >,
    "method": "findAuthenticationProviders",
    "params": {
        "offset": <Optional, numeric index of first item to retrieve >
        "count": <Optional, number of items to retrieve >
    }
}

Response:

{
    "jsonrpc": 2.0,
    "id": < The request identity >,
    "result": {
        "offset": <numeric index of the first item which is part of this response,
                           this is set based on the "offset" parameter provided in the request >
        "count": < number of items in this response, if "count" has been specified in request
                           it is the maximum value of this item >,
        "countAll": < Total number of authentication providers available >,
        "items": [
            {
                "id": < Unique identity for this authentication provider >,
                "name": < User friendly name of this authentication provider >,
                "icon": < Icon representing this authentication provider >,
                "url": < Endpoint to use to login/register using this authentication provider >,
                "addIdentityUrl": < Endpoint to use when adding an additional identity to an existing user
                        using this authentication provider >
            },
            ...
        ]
    }
}

Some important things to note:

Category:Cloud Core Authentication Protocol