openapi: 3.2.0
info:
  title: Dynatrace Account Management Platform Tokens API
  description: The enterprise management API for Dynatrace SaaS enables automation of operational tasks related to user access and environment lifecycle management.
  version: '1.0'
  contact: {}
servers: []
tags:
- name: Platform Tokens
  description: Manage platform tokens for account users.
paths:
  /iam/v1/accounts/{account-uuid}/platform-tokens:
    get:
      operationId: getPlatformTokensForAccount
      parameters:
      - name: account-uuid
        required: true
        in: path
        description: "The ID of the required account. \n\n You can find the UUID on the **Account Management** > **Identity & access management** > **OAuth clients** page, during creation of an OAuth client."
        schema:
          type: string
      - name: searchTerm
        required: false
        in: query
        description: Optional search term. Only platform tokens that match values of tokenId, name, createdBy or scope will be returned.
        schema:
          type: string
      - name: status
        required: false
        in: query
        description: Optional platform token status. Only platform tokens that status matches the value will be returned.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: The number of the requested page.
        schema:
          type: number
      - name: size
        required: false
        in: query
        description: Defines the requested number of entries for the next page.
        schema:
          type: number
      responses:
        '200':
          description: Successful response - platform tokens fetched.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformTokenPageDto'
      security:
      - bearer: []
      summary: Returns platform tokens within account
      tags:
      - Platform Tokens
      x-token-scopes:
      - platform-token:tokens:manage
    post:
      operationId: generatePlatformToken
      parameters:
      - name: account-uuid
        required: true
        in: path
        description: "The ID of the required account. \n\n You can find the UUID on the **Account Management** > **Identity & access management** > **OAuth clients** page, during creation of an OAuth client."
        schema:
          type: string
      requestBody:
        required: true
        description: Platform token creation form
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GeneratePlatformTokenForm'
      responses:
        '200':
          description: Platform token created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformTokenSecret'
      security:
      - bearer: []
      summary: Creates platform token for user
      tags:
      - Platform Tokens
      x-token-scopes:
      - platform-token:tokens:manage
  /iam/v1/accounts/{account-uuid}/platform-tokens/{platform-token-id}:
    delete:
      operationId: deletePlatformToken
      parameters:
      - name: account-uuid
        required: true
        in: path
        description: "The ID of the required account. \n\n You can find the UUID on the **Account Management** > **Identity & access management** > **OAuth clients** page, during creation of an OAuth client."
        schema:
          type: string
      - name: platform-token-id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Successful response - platform token deleted.
      security:
      - bearer: []
      summary: Deletes platform token
      tags:
      - Platform Tokens
      x-token-scopes:
      - platform-token:tokens:manage
  /iam/v1/accounts/{account-uuid}/platform-tokens/{platform-token-id}/expiration-date:
    put:
      operationId: updatePlatformTokenExpirationDate
      parameters:
      - name: account-uuid
        required: true
        in: path
        description: "The ID of the required account. \n\n You can find the UUID on the **Account Management** > **Identity & access management** > **OAuth clients** page, during creation of an OAuth client."
        schema:
          type: string
      - name: platform-token-id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        description: The JSON body of the request. Contains the new expiration date of platform token
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformTokenExpirationDateDto'
      responses:
        '200':
          description: Successful response - platform tokens fetched.
      security:
      - bearer: []
      summary: Updates platform token expiration data
      tags:
      - Platform Tokens
      x-token-scopes:
      - platform-token:tokens:manage
  /iam/v1/accounts/{account-uuid}/platform-tokens/{platform-token-id}/status:
    put:
      operationId: updatePlatformTokenStatus
      parameters:
      - name: account-uuid
        required: true
        in: path
        description: "The ID of the required account. \n\n You can find the UUID on the **Account Management** > **Identity & access management** > **OAuth clients** page, during creation of an OAuth client."
        schema:
          type: string
      - name: platform-token-id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        description: The JSON body of the request. Contains the status the platform token should be changed to.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformTokenStatusUpdateDto'
      responses:
        '204':
          description: Successful response - platform token updated.
      security:
      - bearer: []
      summary: Updates platform token status
      tags:
      - Platform Tokens
      x-token-scopes:
      - platform-token:tokens:manage
components:
  schemas:
    PlatformTokenMetadataDto:
      type: object
      properties:
        lastUsedAt:
          format: date-time
          type: string
        lastClientIp:
          type: string
      required:
      - lastUsedAt
      - lastClientIp
    GeneratePlatformTokenForm:
      type: object
      properties:
        name:
          type: string
        scope:
          type: array
          items:
            type: string
        resource:
          type: array
          items:
            type: string
        tags:
          type: array
          items:
            type: string
        expirationDate:
          format: date-time
          type: string
        userUuid:
          type: string
      required:
      - name
      - scope
      - resource
      - tags
      - expirationDate
      - userUuid
    PlatformTokenSecret:
      type: object
      properties:
        name:
          type: string
        tokenId:
          type: string
        token:
          type: string
      required:
      - name
      - tokenId
      - token
    PlatformTokenStatusUpdateDto:
      type: object
      properties:
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
      required:
      - status
    PlatformTokenDto:
      type: object
      properties:
        tokenId:
          type: string
        accountUuid:
          type: number
        description:
          type: string
        name:
          type: string
        scope:
          type: array
          items:
            type: string
        tags:
          type: array
          items:
            type: string
        resource:
          type: array
          items:
            type: string
        expirationDate:
          format: date-time
          type: string
        userUuid:
          type: string
        metadata:
          $ref: '#/components/schemas/PlatformTokenMetadataDto'
      required:
      - tokenId
      - accountUuid
      - description
      - name
      - scope
      - tags
      - resource
      - expirationDate
      - userUuid
      - metadata
    PlatformTokenPageDto:
      type: object
      properties:
        pageSize:
          type: number
          description: Page size.
        pageNumber:
          type: number
          description: Page number.
        total:
          type: number
          description: Total count of entries.
        results:
          type: array
          items:
            $ref: '#/components/schemas/PlatformTokenDto'
      required:
      - pageSize
      - pageNumber
      - total
      - results
    PlatformTokenExpirationDateDto:
      type: object
      properties:
        expirationDate:
          format: date-time
          type: string
      required:
      - expirationDate
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
externalDocs:
  description: OpenAPI specification
  url: /openapi.json