Introspect

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

GET /api/v1/auth/introspect

Introspect

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.Auth.Introspect(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.IntrospectResponse != nil {
        // handle response
    }
}

200

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Response

200 - application/json

IntrospectResponse contains information about the current user who is authenticated.

IntrospectResponse contains information about the current user who is authenticated.

features · string[] | null

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

permissions · string[] | null

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

principleId · string

The principleID of the current logged in user.

roles · string[] | null

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

userId · string

The userID of the current logged in user.