Skip to content

Members

While the majority of member management must be done through our UI, this API does provide a couple of endpoints that to aid with lapsing memberships.

Endpoints

Log out by SSO ID

Forcefully logs a member out of your app, without removing them entirely. Accepts the following parameters in the body:

ssoId

string | int required

The member's ID as provided by your SSO API. Admins also can not be removed from via this endpoint as a safety measure.

Possible responses:

  • 200 Member removed from channel successfully.
  • 400 Request body validation failed, see errors.validation for details.
  • 404 The member was not found.
HTTP
POST /channels/members.log-out-by-sso-id
Content-Type: application/json
Authorization: Channel <Api Key>
X-Channel: <Channel Identifier>

{
    "ssoId": "ID as provided by your SSO API"
}
JSON
{
    "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "status": 200
}

Remove by SSO ID

Removes a member permanently. Accepts the following parameters in the body:

ssoId

string | int required

The member's ID as provided by your SSO API.

Admins can not be removed from via this endpoint as a safety measure.

Possible responses:

  • 200 Member removed from channel successfully.
  • 400 Request body validation failed, see errors.validation for details.
  • 403 Removal of this member is not authorised; they are most likely an admin.
  • 404 The member was not found.
HTTP
POST /channels/members.remove-by-sso-id
Content-Type: application/json
Authorization: Channel <Api Key>
X-Channel: <Channel Identifier>

{
    "ssoId": "ID as provided by your SSO API"
}
JSON
{
    "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "status": 200
}