@one-view/pd-oneview-auth-types

Handle the Auth and ACL for One View

Usage no npm install needed!

<script type="module">
  import oneViewPdOneviewAuthTypes from 'https://cdn.skypack.dev/@one-view/pd-oneview-auth-types';
</script>

README

FORMAT: 1A VERSION: 1.0.0 HOST: https://api.pd-oneview.net/auth

pd-oneview-auth

Handle the Auth and ACL for One View

exchange [/v1/exchange]

Exchange for a valid JWT token using Cloudflare or Google OpenID token

  • Attributes (ExchangeReply)

Exchange access token [POST]

  • Request (application/json)

    • Attributes (ExchangeRequest)

  • Response 200 (application/json)

    • Attributes (ExchangeReply)

  • Response 400 (application/json)

    • Attributes (Error)

  • Response 401 (application/json)

    • Attributes (Error)

refresh [/v1/refresh]

Get refreshed JWT token using refresh_token

  • Attributes (RefreshReply)

Refresh access token [POST]

  • Request (application/json)

    • Attributes (RefreshRequest)

  • Response 200 (application/json)

    • Attributes (RefreshReply)

  • Response 400 (application/json)

    • Attributes (Error)

  • Response 401 (application/json)

    • Attributes (Error)

Data Structures

int64 (number)

integer (number)

float (number)

date (string)

errorObject (object)

  • status (string)
  • title (string)

Error (object)

  • errors (array[errorObject])

ExchangeRequest

  • token : openid.ajskjea (string)
  • idp: cloudflare (string)

ExchangeReply

  • jwt : jwt.token.here (string)
  • refresh_token : jwt.refresh.token (string)

RefreshRequest

  • token : jwt.refresh.token (string)
  • idp: cloudflare (string)

RefreshReply

  • jwt : jwt.token.here (string)
  • refresh_token : jwt.refresh.token (string)