ONonyx-dot-app
public

Verify User Logged In

Changed on
get/me

Request

  • Base URL
    https://cloud.onyx.app/api
  • URL
    https://cloud.onyx.app/api/me
  • Auth
    HTTP bearer

Response

Successful Response

idstring required
emailstring required
is_activeboolean required
is_superuserboolean required
is_verifiedboolean required
role'limited' | 'basic' | 'admin' | 'curator' | 'global_curator' | 'slack_user' | 'ext_perm_user' required

User roles

  • Basic can't perform any admin actions
  • Admin can perform all admin actions
  • Curator can perform admin actions for groups they are curators of
  • Global Curator can perform admin actions for all groups they are a member of
  • Limited can access a limited set of basic api endpoints
  • Slack are users that have used onyx via slack but dont have a web login
  • External permissioned users that have been picked up during the external permissions sync process but don't have a web login
oidc_expirystring date-time nullable
current_token_created_atstring date-time nullable
current_token_expiry_lengthinteger nullable
is_cloud_superuserboolean
team_namestring nullable
is_anonymous_userboolean nullable
password_configuredboolean nullable

Changes

  • fcb09658bc37Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 2d941ea53eb3Revision changes
    • breaking

      removed the required property //// from the response with the status

    • breaking

      removed the required property //// from the response with the status

    • info

      api tag public added

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status