Akuity

Akuity Auth Service API

The Auth Service API from Akuity — 4 operation(s) for auth service.

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/auth/device-code Start a device login and get a device code · Get Device Code #
Ask an LLM
“How does a CLI start the device login flow for the Akuity Platform?”
“Where do I get a device code to sign in from a headless machine?”
Tell an agent
Start a device login and give me the device code.
Request a new device authorization code.
POST /api/v1/auth/device-token Exchange a device code for a token · Get Device Token #
Ask an LLM
“After approving a device login, how do I get the access token?”
“Can I poll with my device code until the sign-in completes?”
Tell an agent
Exchange device code {device_code} for an access token.
Poll for the token issued to device code {device_code}.
POST /api/v1/auth/refresh-token Refresh an access token · Refresh Access Token #
Ask an LLM
“My session token expired; how do I refresh it?”
“Can I renew an access token without logging in again?”
Tell an agent
Refresh my access token.
Renew the current session's token before it expires.
GET /api/v1/oidc/provider-details Look up OIDC provider details from a discovery URL · Get OIDCProvider Details #
Ask an LLM
“Can the platform read my identity provider's OIDC discovery document?”
“What issuer and endpoints does an OIDC discovery URL resolve to?”
Tell an agent
Get OIDC provider details for discovery URL {discovery_url}.
Resolve the identity provider behind {discovery_url}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/openapi/akuity-auth-service-api-openapi.yml

Other Resources

🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-organization.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-argocd.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-kargo.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-system.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-apikey.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-customrole.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-auth.proto
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/akuity/refs/heads/main/grpc/akuity-extension.proto

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/akuity:akuity-auth-service-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

akuity-auth-service-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: info@akuity.io
    name: Akuity
    url: https://docs.akuity.io/akuity-portal/automation/api
  description: The Auth surface of the Akuity Platform REST API (grpc-gateway projection of auth/v1). Derived mechanically from the protobuf service descriptors and google.api.http annotations published in the akuity/api-client-go Go module.
  title: Akuity Platform API — Auth Auth Service API
  version: v1
servers:
- description: Akuity Platform (SaaS)
  url: https://akuity.cloud
security:
- basicAuth: []
tags:
- name: Auth Service
paths:
  /api/v1/auth/device-code:
    get:
      operationId: AuthService_GetDeviceCode
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_auth_v1_GetDeviceCodeResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Get Device Code
      tags:
      - Auth Service
      x-grpc-method: akuity.auth.v1.AuthService/GetDeviceCode
  /api/v1/auth/device-token:
    post:
      operationId: AuthService_GetDeviceToken
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/akuity_auth_v1_GetDeviceTokenRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_auth_v1_GetDeviceTokenResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Get Device Token
      tags:
      - Auth Service
      x-grpc-method: akuity.auth.v1.AuthService/GetDeviceToken
  /api/v1/auth/refresh-token:
    post:
      operationId: AuthService_RefreshAccessToken
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/akuity_auth_v1_RefreshAccessTokenRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_auth_v1_RefreshAccessTokenResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Refresh Access Token
      tags:
      - Auth Service
      x-grpc-method: akuity.auth.v1.AuthService/RefreshAccessToken
  /api/v1/oidc/provider-details:
    get:
      operationId: AuthService_GetOIDCProviderDetails
      parameters:
      - in: query
        name: discoveryUrl
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/akuity_auth_v1_GetOIDCProviderDetailsResponse'
          description: OK
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: permission denied
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: not found
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
          description: gRPC status error
      summary: Get OIDCProvider Details
      tags:
      - Auth Service
      x-grpc-method: akuity.auth.v1.AuthService/GetOIDCProviderDetails
components:
  schemas:
    akuity_auth_v1_GetDeviceTokenResponse:
      properties:
        accessToken:
          type: string
      title: akuity.auth.v1.GetDeviceTokenResponse
      type: object
    Status:
      properties:
        code:
          description: gRPC status code (google.rpc.Code)
          format: int32
          type: integer
        details:
          items:
            additionalProperties: true
            type: object
          type: array
        message:
          type: string
      title: google.rpc.Status
      type: object
    akuity_auth_v1_GetDeviceCodeResponse:
      properties:
        deviceCode:
          type: string
        expiresInSeconds:
          format: int32
          type: integer
        intervalSeconds:
          format: int32
          type: integer
        userCode:
          type: string
        verificationUri:
          type: string
        verificationUriComplete:
          type: string
      title: akuity.auth.v1.GetDeviceCodeResponse
      type: object
    akuity_auth_v1_GetOIDCProviderDetailsResponse:
      properties:
        authorizationEndpoint:
          type: string
        issuer:
          type: string
        jwksUri:
          type: string
        tokenEndpoint:
          type: string
        userinfoEndpoint:
          type: string
      title: akuity.auth.v1.GetOIDCProviderDetailsResponse
      type: object
    akuity_auth_v1_GetDeviceTokenRequest:
      properties:
        deviceCode:
          type: string
      title: akuity.auth.v1.GetDeviceTokenRequest
      type: object
    akuity_auth_v1_RefreshAccessTokenRequest:
      title: akuity.auth.v1.RefreshAccessTokenRequest
      type: object
    akuity_auth_v1_RefreshAccessTokenResponse:
      title: akuity.auth.v1.RefreshAccessTokenResponse
      type: object
  securitySchemes:
    basicAuth:
      description: 'HTTP Basic auth: username = AKUITY_API_KEY_ID, password = AKUITY_API_KEY_SECRET.'
      scheme: basic
      type: http