Code create

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.

POSThttps://api.bringyour.com/auth/code-create

Body

duration_minutesnumber

usesinteger

Response

Body

auth_codestring

duration_minutesnumber

usesinteger

errorobject

auth_code_limit_exceededboolean

messagestring

Request

Response

POSThttps://api.bringyour.com/auth/code-create

Body

duration_minutesnumber

usesinteger

Response

Body

auth_codestring

duration_minutesnumber

usesinteger

errorobject

auth_code_limit_exceededboolean

messagestring

Request

Response

const response = await fetch('https://api.bringyour.com/auth/code-create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "auth_code": "text",
  "duration_minutes": 0,
  "uses": 0,
  "error": {
    "auth_code_limit_exceeded": false,
    "message": "text"
  }
}