Introspect

Introspect

client.auth.introspect(RequestOptionsoptions?): featuresunionpermissionsunionprincipleIdstringrolesunionuserIdstringAuthIntrospectResponse

get/api/v1/auth/introspect

Introspect returns the current user's principle_id, user_id and a list of roles, permissions, and enabled features.

Returns

AuthIntrospectResponse

IntrospectResponse contains information about the current user who is authenticated.

Hide ParametersShow Parameters

featuresunion

optional

Array<string> | null

The list of feature flags enabled for the tenant the logged in user belongs to.

permissionsunion

optional

Array<string> | null

The list of permissions that the current logged in user has.

principleIdstring

optional

The principleID of the current logged in user.

rolesunion

optional

Array<string> | null

The list of roles that the current logged in user has.

userIdstring

optional

The userID of the current logged in user.

Request example TypeScript

import ConductoroneSDK from 'conductorone-sdk';

const client = new ConductoroneSDK({
  apiKey: 'My API Key',
});

const response = await client.auth.introspect();

console.log(response.features);

200 Example

{
  "features": [
    "string"
  ],
  "permissions": [
    "string"
  ],
  "principleId": "principleId",
  "roles": [
    "string"
  ],
  "userId": "userId"
}