2023.01

2023.01

  • Imply
  • Ingest
  • Query
  • Visualize
  • Administer
  • Deploy

›Pivot API

Overview

  • Pivot overview
  • Datasources
  • SQL

Data cubes

  • About data cubes
  • Managing data cubes
  • Visualizations
  • Dimensions
  • Measures
  • Custom dimensions and measures
  • Time compare
  • Filter by measure
  • Annotations
  • Data export

Dashboards

  • Viewing dashboards
  • Creating dashboards
  • Managing dashboards

Alerts & Reports

  • Alerts
  • Scheduled reports

User access

  • Access control
  • User management in Pivot
  • Manage users with LDAP
  • Manage users with OIDC

Advanced features

  • Feature Flags
  • Customizing the Pivot UI
  • Generating links into Pivot
  • Monitor queries
  • Explain
  • CrossTab
  • Pivot server config
  • Plywood Expressions
  • Query parameters reference

Pivot API

  • Pivot API overview
  • Pivot users API
  • Pivot UserAuth API
  • Pivot user statuses API
  • Pivot roles API
  • Pivot connections API
  • Pivot data cubes API
  • Pivot dashboards API
  • Pivot alerts API
  • Pivot reports API

Pivot UserAuth API

If you have access to this API, you can create, read, or edit your UserAuth objects that represent user authentications.

Pivot must be running in native users mode.

The response strings for currentPass and passHistory are hashed passwords. They are not plain text passwords.

Get all UserAuth objects or a get single UserAuth with a name you specify

Returns a list of all UserAuth objects, or returns a UserAuth with a {name} that you specify.

URL

GET /api/v1/user-auths/{name}

Success response

CodeDescription
200OK

Selected error response

CodeExample body
404 Not Found”error": "Not found."

Sample request

curl --location --request GET 'http://localhost:9095/api/v1/user-auths' \
--header 'x-imply-api-token:<token>'

Response body

[
  {
    "name": "string",
    "currentPass": "string",
    "passHistory": [
      "string"
    ],
    "isTwoFactorAuthEnabled": false,
    "twoFactorAuthSecret": "string"
  }
]

Create or update a UserAuth by name

Creates or updates a UserAuth with a {name} that you specify.

URL

POST /api/v1/user-auths/{name}

Request body

curl -X POST --header "Content-Type:application/json" --header "x-imply-api-token:<token>" --data '
{
  "userAuth": {
    "name": "string",
    "currentPass": "string",
    "passHistory": [
      "string"
    ],
    "isTwoFactorAuthEnabled": false,
    "twoFactorAuthSecret": "string"
  }
}

Success response

CodeDescription
200OK

Selected error response

CodeExample body
404 Not Found”error": "Not found."

Response body

[
  {
    "name": "string",
    "currentPass": "string",
    "passHistory": [
      "string"
    ],
    "isTwoFactorAuthEnabled": false,
    "twoFactorAuthSecret": "string"
  }
]

Delete a UserAuth by name

Deletes a UserAuth with a {name} that you specify.

URL

DELETE /api/v1/user-auths/{name}

Sample request

curl -X DELETE --header "x-imply-api-token:<token>" localhost:9095/api/v1/user-auths/<userAuthName>

Success response

CodeDescription
200OK

Selected error response

CodeExample body
404 Not Found”error": "Not found."
Last updated on 5/6/2021
← Pivot users APIPivot user statuses API →
  • Get all UserAuth objects or a get single UserAuth with a name you specify
    • URL
    • Success response
    • Selected error response
    • Sample request
    • Response body
  • Create or update a UserAuth by name
    • URL
    • Request body
    • Success response
    • Selected error response
    • Response body
  • Delete a UserAuth by name
    • URL
    • Sample request
    • Success response
    • Selected error response
2023.01
Key links
Try ImplyApache Druid siteImply GitHub
Get help
Stack OverflowSupportContact us
Learn more
Apache Druid forumsBlog
Copyright © 2023 Imply Data, Inc