Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Members

Get the authenticated account member

Gets the authenticated account member's details.

get/v2/members/me

Response

Successful Response

idstring uuid required

Unique id of the account member

emailstring email required

Email of the user controlling this account

email_verifiedboolean required

Whether this email address is verified or not. For social providers like 'Login with Google' this is done automatically, otherwise we will send the user a verification link in email.

namestring

Name of this user

given_namestring

First name of the user

family_namestring

Last name of the user

picturestring

URL to picture, photo, or avatar of the user that controls this account.

is_superuserboolean required

Whether or not this user has special access to permit.io organizations

is_onboardingboolean required

Whether or not this user is currently onboarding, needs to be replaced by a user journey object

onboarding_step'create_organization' | 'create_project' | 'create_resource' | 'create_actions' | 'assign_permissions' | 'assign_user_roles' | 'connect_sdk' | 'done' required

An enumeration.

created_atstring date-time required

Date and time when the account member was created (ISO_8601 format).

last_loginstring date-time

Last date and time this user logged in (ISO_8601 format).

last_ipstring

Last IP address from which this user logged in.

logins_countinteger

Total number of logins this user has performed.

settingsobject required

Custom permit.io dashboard settings, such as preferred theme, etc.

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "email": "janedoe@permituser.com",
  "email_verified": true,
  "given_name": "Jane",
  "family_name": "Doe",
  "name": "Jane Josephine Doe",
  "picture": "http://permituser.com/janedoe/me.jpg",
  "settings": {
    "option": "value",
    "another-option": "another-value"
  },
  "is_superuser": false,
  "is_onboarding": true,
  "onboarding_step": "done",
  "created_at": "2019-08-20T14:15:22Z",
  "last_login": "2019-08-24T14:15:22Z",
  "last_ip": "1.2.3.4",
  "logins_count": 2,
  "identities": [
    {
      "user_id": "google-oauth2|000000000000000000001",
      "provider": "google-oauth2",
      "sub": "000000000000000000001",
      "email": "Jane@permituser.com",
      "email_verified": true,
      "user_info": {
        "sub": "000000000000000000001",
        "name": "Jane Josephine Doe",
        "given_name": "Jane",
        "family_name": "Doe",
        "middle_name": "Josephine",
        "nickname": "JJ",
        "preferred_username": "j.doe",
        "profile": "http://permituser.com/janedoe",
        "picture": "http://permituser.com/janedoe/me.jpg",
        "website": "http://permituser.com",
        "email": "janedoe@permituser.com",
        "email_verified": true,
        "gender": "female",
        "birthdate": "1972-03-31",
        "zoneinfo": "America/Los_Angeles",
        "locale": "en-US",
        "phone_number": "+1 (111) 222-3434",
        "phone_number_verified": false,
        "address": {
          "country": "us"
        },
        "updated_at": "1556845729"
      }
    }
  ],
  "invite": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
    "invite_code": "40ef0e48-a11f-4963-a229-e396c9eeefff",
    "email": "Jane@permituser.com",
    "role": "admin",
    "created_at": "2019-08-24T14:15:22Z",
    "status": "pending",
    "failed_reason": ""
  },
  "grants": [
    {
      "object_type": "org",
      "access_level": "admin",
      "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
    }
  ]
}