AuthorisationRequestSuccessResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akahu/main/json-schema/akahu-authorisation-request-success-response-schema.json",
  "title": "AuthorisationRequestSuccessResponse",
  "x-generated": "2026-10-26",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/akahu-auth-api-openapi.yml#/components/schemas/AuthorisationRequestSuccessResponse",
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean",
      "enum": [
        true
      ]
    },
    "request_uri": {
      "type": "string",
      "description": "The pushed authorisation request_uri that should be specified in the authorisation URL."
    },
    "authorisation_url": {
      "type": "string",
      "format": "uri",
      "description": "A pre-built authorisation URL that the user can be redirected to for authorisation, this includes the request_uri and any other necessary query parameters."
    },
    "expires_in": {
      "type": "number",
      "description": "The number of seconds until the request URI expires."
    }
  },
  "required": [
    "success",
    "request_uri",
    "authorisation_url",
    "expires_in"
  ]
}