Code create

post

Create a limited use code (auth code) to share authentication with connected apps and tools. The code is tied to the caller session, and will be expired with any of the caller's sessions. Currently a code cannot be created for a client JWT (from /network/auth-client). This is a subset of an OAuth flow.

Body

duration_minutesnumberOptional

usesintegerOptional

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /auth/code-create HTTP/1.1
Host: api.bringyour.com
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "duration_minutes": 1,
  "uses": 1
}

200Success

{
  "auth_code": "text",
  "duration_minutes": 1,
  "uses": 1,
  "error": {
    "auth_code_limit_exceeded": true,
    "message": "text"
  }
}