Armory

Armory Credentials Controller API

The credentials-controller API from Armory — 4 operation(s) for credentials-controller.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.armory.io/plugins/scale-agent/
📖
APIReference
https://docs.armory.io/plugins/scale-agent/reference/
📖
GettingStarted
https://docs.armory.io/plugins/scale-agent/install/quickstart/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/armory/refs/heads/main/authentication/armory-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/armory/refs/heads/main/openapi/armory-credentials-controller-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/armory/docs

Other Resources

🔗
Swagger
https://docs.armory.io/reference/scale-agent/swagger.json
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/armory/refs/heads/main/conventions/armory-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/armory/refs/heads/main/errors/armory-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/armory/refs/heads/main/data-model/armory-data-model.yml

OpenAPI Specification

armory-credentials-controller-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Armory Scale Agent Credentials Credentials Controller API
  description: Account credential lifecycle operations - list, create, update, delete and history - plus artifact credentials.
  version: 0.13.x
  contact:
    name: Armory Docs
    url: https://docs.armory.io/plugins/scale-agent/
  x-origin:
  - format: swagger
    version: '2.0'
    url: https://docs.armory.io/reference/scale-agent/swagger.json
servers:
- url: /
tags:
- name: credentials-controller
paths:
  /credentials:
    get:
      tags:
      - credentials-controller
      summary: listAccountCredentials
      operationId: listAccountCredentialsUsingGET
      parameters:
      - name: expand
        in: query
        description: expand
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Map_string_object'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
    post:
      tags:
      - credentials-controller
      summary: createAccount
      operationId: createAccountUsingPOST
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CredentialsDefinition'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialsDefinition'
        description: definition
        required: true
    put:
      tags:
      - credentials-controller
      summary: updateAccount
      operationId: updateAccountUsingPUT
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/CredentialsDefinition'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialsDefinition'
        description: definition
        required: true
  /credentials/type/{accountType}:
    get:
      tags:
      - credentials-controller
      summary: listAccountsByType
      operationId: listAccountsByTypeUsingGET
      parameters:
      - name: accountType
        in: path
        description: accountType
        required: true
        schema:
          type: string
      - name: limit
        in: query
        description: limit
        required: true
        schema:
          type: string
      - name: startingAccountName
        in: query
        description: startingAccountName
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CredentialsDefinition'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
  /credentials/{accountName}:
    get:
      tags:
      - credentials-controller
      summary: getAccountCredentialsDetails
      operationId: getAccountCredentialsDetailsUsingGET
      parameters:
      - name: accountName
        in: path
        description: accountName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
    delete:
      tags:
      - credentials-controller
      summary: deleteAccount
      operationId: deleteAccountUsingDELETE
      parameters:
      - name: accountName
        in: path
        description: accountName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      deprecated: false
  /credentials/{accountName}/history:
    get:
      tags:
      - credentials-controller
      summary: getAccountHistory
      operationId: getAccountHistoryUsingGET
      parameters:
      - name: accountName
        in: path
        description: accountName
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Revision'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
components:
  schemas:
    CredentialsDefinition:
      type: object
      properties:
        name:
          type: string
      title: CredentialsDefinition
    Map_string_object:
      type: object
      title: Map«string,object»
      additionalProperties:
        type: object
    Revision:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/CredentialsDefinition'
        timestamp:
          type: integer
          format: int64
        version:
          type: integer
          format: int32
      title: Revision