Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-2410185524.2 KB
Authentication

get all

Authenticate a token to confirm it's valid, check the logged-in user, or confirm token privileges. You can use /authenticate to find the organisation UUID of the token you are using, which may be useful in future requests.

For custom components:

RaiselyComponents.api.all('authenticate').get(params = {}, headers = {}) => Promise<{result}>

:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper

get/authenticate

Headers

Authorizationstring

A valid HTTP Bearer token, required to access private records.

Response

The created user model (public only)

campaignsstring[]

UUIDs of campaigns this user is assigned to

rolesstring[]

Roles granted to this token (may be a subset of those granted to the user)

permissionstring

A specific permission that is granted to this token

Example response

{
  "data": {
    "accessToken": "aaabbbccc",
    "address1": "31 Sunset Boulevard",
    "address2": "Unit 31b",
    "adminSettings": {
      "v4BetaOptin": true,
      "starredCampaigns": [
        "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj"
      ]
    },
    "country": "AU",
    "createdAt": "2020-12-03T06:52:46.330Z",
    "email": "harveymilk@example.com",
    "facebookId": "fb_someurl",
    "firstName": "Leila",
    "fullName": "Leila Norma de Lima",
    "internal": {},
    "isAdmin": true,
    "isSamlLogin": true,
    "lastName": "de Lima",
    "organisationUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "permission": "PARTICIPANT",
    "phoneNumber": "+1 123-456-7890",
    "photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
    "postcode": "AAA BBBB",
    "preferredName": "Norma",
    "private": {
      "fieldA": "one",
      "fieldB": "yes"
    },
    "public": {
      "fieldA": "one",
      "fieldB": "yes"
    },
    "state": "Victoria",
    "status": "ACTIVE",
    "suburb": "Melbourne",
    "tags": [
      {
        "color": "#ff0000",
        "createdAt": "2020-12-03T06:52:46.330Z",
        "internal": {},
        "isPrivate": true,
        "label": "My Custom Tag",
        "organisationUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
        "path": "example-path",
        "recordType": "user",
        "updatedAt": "2020-12-03T06:52:46.330Z",
        "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "unsubscribedAt": "2020-12-03T06:52:46.330Z",
    "updatedAt": "2020-12-03T06:52:46.330Z",
    "username": "harveymilk@example.com",
    "uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
  }
}