openapi: 3.0.0
info:
  title: Okta Privileged Access
  description: >-
    The OPA API is a control plane used to request operations in Okta Privileged
    Access (formerly ScaleFT/Advanced Server Access)


    Contact Support:
     Name: Okta Support
     Email: support@okta.com
  version: 1.0.0
servers:
  - url: http://{{baseurl}}
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
security:
  - bearerAuth: []
tags:
  - name: Attributes
    description: Attributes control specific settings for OPA Users and Groups.
  - name: Clients
    description: >-
      An OPA Client corresponds to a specific device. Clients are the primary
      way Users access OPA resources.


      See [Okta Privileged Access
      clients](https://help.okta.com/okta_help.htm?type=oie&id=ext-pam-clients).
  - name: Cloud Infrastructure Entitlements
    description: >-
      The Cloud Infrastructure Entitlements API automatically determines which
      cloud infrastructure resources are accessible to users through
      entitlements. This feature enables OPA admins to determine the risks to
      high-value resources in their cloud infrastructure applications and take
      measures to remediate those risks.


      See [Cloud infrastructure entitlement discovery and
      analysis](https://help.okta.com/okta_help.htm?type=oie&id=ext-pam-entitlement-analysis).


      Currently, this feature only supports AWS and allows Teams to analyze
      entitlements that grant end user access to Amazon Relational Database
      Service (RDS).
  - name: Gateways
    description: >-
      An OPA Gateway controls access to servers in your Project.


      See [Okta Privileged Access
      gateways](https://help.okta.com/okta_help.htm?type=oie&id=ext-pam-gateways).
  - name: Groups
    description: >-
      An OPA Group is a collection of Users that share permissions and access to
      Resources.


      See
      [Groups](https://help.okta.com/okta_help.htm?type=oie&id=ext-pam-groups).
  - name: Projects
    description: >-
      An OPA Project is a collection of Resources that share settings.


      See
      [Projects](https://help.okta.com/okta_help.htm?type=oie&id=ext-pam-projects).
  - name: Access Reports
    description: >-
      The Access Reports API is a convenient way of generating reports on Users
      and Resources for your Team. You can use Okta Workflows to interact with
      these operations and store generated reports in a Workflows Table.
  - name: Resource Groups
    description: >-
      An OPA Resource Group is a collection of Projects.


      See [Resource
      groups](https://help.okta.com/okta_help.htm?type=oie&id=ext-pam-resource-groups).
  - name: Secrets
    description: >-
      The Secrets API provides operations to manage Secrets for OPA Teams.
      Secrets are encrypted key-value pairs used to store sensitive information.


      See
      [Secrets](https://help.okta.com/okta_help.htm?type=oie&id=ext-pam-secrets).
  - name: Security Policy
    description: >-
      The Security Policy API provides operations to manage Security Policies
      for OPA Teams. Security Policies control which User Groups can access
      resources and any methods they can use to connect. Security Policy
      operations use several nested objects to correctly define a created
      policy.


      See [Security
      policy](https://help.okta.com/okta_help.htm?type=oie&id=ext-pam-policy).
  - name: Servers
    description: >-
      The Servers API provides operations relate to Servers enrolled in an OPA
      Project.
  - name: Service Users
    description: >-
      An OPA Service User is used to access the OPA API. Each Service User is
      provided tokens used to authenticate and authorize against the service.
  - name: Teams
    description: >-
      An OPA Team is the top-level organizational container. Each Team maps to a
      single app in the Okta dashboard.
  - name: Users
    description: A User corresponds to a human or Service User in an OPA Team.
paths:
  /v1/teams/{team_name}/attributes/conflicts:
    get:
      tags:
        - Attributes
      summary: List all Attribute Conflicts for a Team
      description: |-
        Lists all attribute conflicts for your Team

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: count
          in: query
          schema:
            type: string
          description: The number of objects per page
          example: <integer>
        - name: descending
          in: query
          schema:
            type: string
          description: The object order
          example: <boolean>
        - name: offset
          in: query
          schema:
            type: string
          description: >-
            The offset value for pagination. The **rel="next"** and
            **rel="prev"** `Link` headers define the offset for subsequent or
            previous pages.
          example: <string>
        - name: prev
          in: query
          schema:
            type: string
          description: The direction of paging
          example: <boolean>
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
                example: consectetur occaecat
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - attribute_name: unix_user_name
                    attribute_value: Sec.Admin
                    id: 11faefa1-6b59-4a5a-9492-43195cd07385
                    is_service_user: false
                    user_name: OPA.User.1
                  - attribute_name: unix_user_name
                    attribute_value: Sec.Admin
                    id: 11faefa1-6b59-4a5b-9492-43195cd07385
                    is_service_user: false
                    user_name: OPA.User.2
                  - attribute_name: unix_gid
                    attribute_value: 1001
                    id: b06dfc59-ae9c-4q43-b583-96d09988fd84
                    user_name: OPA.User.3
                  - attribute_name: unix_gid
                    attribute_value: 1001
                    id: ff2c0f25-b73d-4t20-8aeb-b6c39a68a204
                    is_service_user: true
                    user_name: OPA.User.4
  /v1/teams/{team_name}/groups/{group_name}/attributes:
    get:
      tags:
        - Attributes
      summary: List all Attributes for a Group
      description: >-
        Lists all Attributes for a specified Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: count
          in: query
          schema:
            type: string
          description: The number of objects per page
          example: <integer>
        - name: descending
          in: query
          schema:
            type: string
          description: The object order
          example: <boolean>
        - name: offset
          in: query
          schema:
            type: string
          description: >-
            The offset value for pagination. The **rel="next"** and
            **rel="prev"** `Link` headers define the offset for subsequent or
            previous pages.
          example: <string>
        - name: prev
          in: query
          schema:
            type: string
          description: The direction of paging
          example: <boolean>
        - name: conflicting
          in: query
          schema:
            type: string
          description: >-
            When `true`, only return attributes that conflict with other
            attributes on your Team
          example: <boolean>
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: group_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of a Group
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
                example: consectetur occaecat
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - id: 36844d7c-f311-4a42-866c-f32a5a41e213
                    attribute_name: unix_group_name
                    attribute_value: group_old
                    managed: false
                  - id: 8eb50e3f-ef90-4215-b358-9318b35867de
                    attribute_name: windows_group_name
                    attribute_value: group_new
                    managed: false
  /v1/teams/{team_name}/groups/{group_name}/attributes/{attribute_id}:
    get:
      tags:
        - Attributes
      summary: Retrieve a Group Attribute
      description: >-
        Retrieves an Attribute for a Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: group_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of a Group
          example: <string>
        - name: attribute_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of an Attribute
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                attribute_name: unix_group_name
                attribute_value: group_old
                id: 36844d7c-f311-4a42-866c-f32a5a41e213
                managed: false
    put:
      tags:
        - Attributes
      summary: Update a Group Attribute
      description: |-
        Updates an Attribute for a Group

        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                attribute_name: <string>
                attribute_value: <integer>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: group_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of a Group
          example: <string>
        - name: attribute_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of an Attribute
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/users/{user_name}/attributes:
    get:
      tags:
        - Attributes
      summary: List all Attributes for a User
      description: |-
        Lists all Attributes for a specified user

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: count
          in: query
          schema:
            type: string
          description: The number of objects per page
          example: <integer>
        - name: descending
          in: query
          schema:
            type: string
          description: The object order
          example: <boolean>
        - name: offset
          in: query
          schema:
            type: string
          description: >-
            The offset value for pagination. The **rel="next"** and
            **rel="prev"** `Link` headers define the offset for subsequent or
            previous pages.
          example: <string>
        - name: prev
          in: query
          schema:
            type: string
          description: The direction of paging
          example: <boolean>
        - name: conflicting
          in: query
          schema:
            type: string
          description: >-
            When `true`, only return attributes that conflict with other
            attributes on your Team
          example: <boolean>
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: user_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The username for an existing User
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
                example: consectetur occaecat
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - id: 11faefa1-6b59-4a52-9492-43195cd07385
                    attribute_name: unix_user_name
                    attribute_value: augusta_ada_king
                    managed: true
                  - id: 11faefa1-6b59-4a52-9492-43195cd07385
                    attribute_name: unix_uid
                    attribute_value: 1210
                    managed: true
                  - id: b06dfc59-ae9c-4243-b583-96d09988fd84
                    attribute_name: unix_gid
                    attribute_value: 1210
                    managed: true
                  - id: ff2c0f25-b73d-4720-8aeb-b6c39a68a204
                    attribute_name: windows_user_name
                    attribute_value: augusta_ada_king
                    managed: true
  /v1/teams/{team_name}/users/{user_name}/attributes/{attribute_id}:
    get:
      tags:
        - Attributes
      summary: Retrieve a User Attribute
      description: |-
        Retrieves an Attribute for a User

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: user_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The username for an existing User
          example: <string>
        - name: attribute_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of an Attribute
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                attribute_name: unix_user_name
                attribute_value: augusta_ada_king
                id: 11faefa1-6b59-4a52-9492-43195cd07385
                managed: true
    put:
      tags:
        - Attributes
      summary: Update a User Attribute
      description: |-
        Updates an Attribute for a User

        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                attribute_name: <string>
                attribute_value: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: user_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The username for an existing User
          example: <string>
        - name: attribute_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of an Attribute
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/clients:
    get:
      tags:
        - Clients
      summary: List all Clients
      description: >-
        Returns a list of Clients for your Team. By default, this only returns
        Clients associated with the requesting User. Use query parameters to
        adjust the list of returned Clients.


        This endpoint requires one of the following roles: `end_user`,
        `security_admin`, `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: all
          in: query
          schema:
            type: string
          description: When `true`, returns all Clients for the Team
          example: <boolean>
        - name: count
          in: query
          schema:
            type: string
          description: The number of objects per page
          example: <integer>
        - name: descending
          in: query
          schema:
            type: string
          description: The object order
          example: <boolean>
        - name: offset
          in: query
          schema:
            type: string
          description: >-
            The offset value for pagination. The **rel="next"** and
            **rel="prev"** `Link` headers define the offset for subsequent or
            previous pages.
          example: <string>
        - name: prev
          in: query
          schema:
            type: string
          description: The direction of paging
          example: <boolean>
        - name: state
          in: query
          schema:
            type: string
          description: >-
            Only return Clients with the specified state. Valid statuses:
            `ACTIVE`, `PENDING`, or `DELETED`.
          example: <string>
        - name: username
          in: query
          schema:
            type: string
          description: >-
            Only return Clients assigned to the specified User. An empty string
            returns unassigned Clients.
          example: <string>
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
                example: consectetur occaecat
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - id: 9c199afe-0ca5-427a-baac-c4341707d82b
                    user_name: Jason.Compson.IV
                    description: Work laptop
                    hostname: LightInAugust
                    os: macOS 10.14.6
                    encrypted: true
                    deleted_at: null
                    state: PENDING
                  - id: 5e9d8179-2fca-4905-8405-3cd3e0c5280e
                    user_name: Jason.Compson.IV
                    description: Personal laptop
                    hostname: Absalom
                    os: macOS 10.14.6
                    encrypted: true
                    deleted_at: null
                    state: ACTIVE
  /v1/teams/{team_name}/clients/{client_id}:
    get:
      tags:
        - Clients
      summary: Retrieve a Client
      description: >-
        Retrieves the properties of a specified Client


        This endpoint requires one of the following roles: `end_user`,
        `security_admin`, `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: client_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Client
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                deleted_at: null
                description: Work laptop
                encrypted: true
                hostname: LightInAugust
                id: 9c199afe-0ca5-427a-baac-c4341707d82b
                os: macOS 10.14.6
                state: PENDING
                user_name: Jason.Compson.IV
    put:
      tags:
        - Clients
      summary: Update a Client
      description: >-
        Updates the state or assigned user for a specified Client. This is
        required for some enrollment policies. See [Silently enroll the
        Client](https://help.okta.com/okta_help.htm?type=asa&id=ext-asa-enroll-sft-silent).


        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                state: <string>
                user_name: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: client_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Client
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
    delete:
      tags:
        - Clients
      summary: Revoke access to a Client
      description: >-
        Revokes access to a specified Client from your Team


        This endpoint requires one of the following roles: `end_user`,
        `security_admin`, `resource_admin`.
      parameters:
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: client_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Client
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/cloud_connections:
    get:
      tags:
        - Cloud Infrastructure Entitlements
      summary: List all Cloud Connections
      description: |-
        Lists all existing Cloud Connections

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - id: 5f3159e9-e7ab-428e-8a87-c2ebffe407f6
                    name: APAC-1
                    provider: aws
                    cloud_connection_details:
                      account_id: '123456789012'
                      external_id: b4c617de-d58e-4d47-bbdf-c3a3db98ed3d
                      role_arn: arn:aws:iam::000000000000:role/example
                  - id: 5f3159e9-e7ab-428e-8a87-c2ebffe407f6
                    name: APAC-1
                    provider: aws
                    cloud_connection_details:
                      account_id: '123456789012'
                      external_id: b4c617de-d58e-4d47-bbdf-c3a3db98ed3d
                      role_arn: arn:aws:iam::000000000000:role/example
    post:
      tags:
        - Cloud Infrastructure Entitlements
      summary: Create a Cloud Connection
      description: >-
        Creates a connection to a specified cloud provider. Currently, this only
        supports AWS.


        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <regex>
                provider: <string>
                cloud_connection_details:
                  account_id: <string>
                  external_id: <string>
                  role_arn: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: APAC-1
                provider: <string>
                cloud_connection_details:
                  account_id: '123456789012'
                  external_id: b4c617de-d58e-4d47-bbdf-c3a3db98ed3d
                  role_arn: arn:aws:iam::000000000000:role/example
                id: 5f3159e9-e7ab-428e-8a87-c2ebffe407f6
  /v1/teams/{team_name}/cloud_connections/check:
    post:
      tags:
        - Cloud Infrastructure Entitlements
      summary: Check a Cloud Connection
      description: |-
        Checks an existing Cloud Connection.

        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                provider: <string>
                cloud_connection_details:
                  account_id: <string>
                  external_id: <string>
                  role_arn: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: failure
                details: aliquip officia sunt culpa
  /v1/teams/{team_name}/cloud_connections/{connection_id}:
    get:
      tags:
        - Cloud Infrastructure Entitlements
      summary: Retrieve a Cloud Connection
      description: |-
        Retrieves an existing Cloud Connection

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: connection_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Cloud Connection
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: APAC-1
                provider: <string>
                cloud_connection_details:
                  account_id: '123456789012'
                  external_id: b4c617de-d58e-4d47-bbdf-c3a3db98ed3d
                  role_arn: arn:aws:iam::000000000000:role/example
                id: 5f3159e9-e7ab-428e-8a87-c2ebffe407f6
    put:
      tags:
        - Cloud Infrastructure Entitlements
      summary: Update a Cloud Connection
      description: |-
        Updates an existing Cloud Connection

        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <regex>
                provider: <string>
                cloud_connection_details:
                  account_id: <string>
                  external_id: <string>
                  role_arn: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: connection_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Cloud Connection
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: APAC-1
                provider: <string>
                cloud_connection_details:
                  account_id: '123456789012'
                  external_id: b4c617de-d58e-4d47-bbdf-c3a3db98ed3d
                  role_arn: arn:aws:iam::000000000000:role/example
                id: 5f3159e9-e7ab-428e-8a87-c2ebffe407f6
    delete:
      tags:
        - Cloud Infrastructure Entitlements
      summary: Delete a Cloud Connection
      description: |-
        Deletes an existing Cloud Connection

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: connection_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Cloud Connection
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/cloud_connections/{connection_id}/accounts:
    get:
      tags:
        - Cloud Infrastructure Entitlements
      summary: List all accounts for a Cloud Connection
      description: >-
        Lists all accounts for a specified Cloud Connection. This is used to run
        Entitlement Analysis jobs.


        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: connection_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Cloud Connection
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                account_id:
                  - '012345678911'
                  - '012345678912'
                  - '012345678913'
                  - '012345678914'
                  - '012345678915'
                  - '012345678916'
  /v1/teams/{team_name}/cloud_entitlement_analyses:
    get:
      tags:
        - Cloud Infrastructure Entitlements
      summary: List all Cloud Entitlement Jobs
      description: |-
        Lists all Cloud Entitlement Jobs.

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
    post:
      tags:
        - Cloud Infrastructure Entitlements
      summary: Create a Cloud Entitlement Job
      description: |-
        Creates a Cloud Entitlement Job

        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <regex>
                connection_id: <regex>
                account_ids:
                  - <string>
                  - <string>
                discovery_rules:
                  - resource_details:
                      type: <string>
                      action:
                        - <string>
                        - <string>
                    rules:
                      additionalProperties: <string>
                  - resource_details:
                      type: <string>
                      action:
                        - <string>
                        - <string>
                    rules:
                      additionalProperties: <string>
                analysis_rules:
                  - rules:
                      additionalProperties: <string>
                  - rules:
                      additionalProperties: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: <regex>
                connection_id: 5f3159e9-e7ab-428e-8a87-c2ebffe407f6
                account_ids:
                  - '012345678911'
                  - '012345678912'
                  - '012345678913'
                  - '012345678914'
                  - '012345678915'
                  - '012345678916'
                discovery_rules:
                  - resource_details:
                      type: rds
                      action:
                        - rds-db:connect
                        - rds-db:connect
                    rules:
                      additionalProperties: resource_name_pattern
                  - resource_details:
                      type: rds
                      action:
                        - rds-db:connect
                        - rds-db:connect
                    rules:
                      additionalProperties: resource_name_pattern
                analysis_rules:
                  - rules:
                      excessive_user_access: '10'
                    '[object Object]': null
                created_at: '2023-08-25T12:00:00.000000Z'
                id: 5f3159e9-e7ab-428e-8a87-c2ebffe407f6
                status: COMPLETED
                updated_at: '2023-08-25T12:00:00.000000Z'
  /v1/teams/{team_name}/cloud_entitlement_analyses/{cloud_entitlement_analysis_id}:
    get:
      tags:
        - Cloud Infrastructure Entitlements
      summary: Retrieve a Cloud Entitlement Job
      description: |-
        Retrieves a specified Cloud Entitlement Job

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: cloud_entitlement_analysis_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Cloud Entitlement Job
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: <regex>
                connection_id: 5f3159e9-e7ab-428e-8a87-c2ebffe407f6
                account_ids:
                  - '012345678911'
                  - '012345678912'
                  - '012345678913'
                  - '012345678914'
                  - '012345678915'
                  - '012345678916'
                discovery_rules:
                  - resource_details:
                      type: rds
                      action:
                        - rds-db:connect
                        - rds-db:connect
                    rules:
                      additionalProperties: resource_name_pattern
                  - resource_details:
                      type: rds
                      action:
                        - rds-db:connect
                        - rds-db:connect
                    rules:
                      additionalProperties: resource_name_pattern
                analysis_rules:
                  - rules:
                      excessive_user_access: '10'
                    '[object Object]': null
                created_at: '2023-08-25T12:00:00.000000Z'
                id: 5f3159e9-e7ab-428e-8a87-c2ebffe407f6
                status: COMPLETED
                updated_at: '2023-08-25T12:00:00.000000Z'
    put:
      tags:
        - Cloud Infrastructure Entitlements
      summary: Update a Cloud Entitlement Job
      description: |-
        Updates an existing Cloud Entitlement Job

        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <regex>
                connection_id: <regex>
                account_ids:
                  - <string>
                  - <string>
                discovery_rules:
                  - resource_details:
                      type: <string>
                      action:
                        - <string>
                        - <string>
                    rules:
                      additionalProperties: <string>
                  - resource_details:
                      type: <string>
                      action:
                        - <string>
                        - <string>
                    rules:
                      additionalProperties: <string>
                analysis_rules:
                  - rules:
                      additionalProperties: <string>
                  - rules:
                      additionalProperties: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: cloud_entitlement_analysis_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Cloud Entitlement Job
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: <regex>
                connection_id: 5f3159e9-e7ab-428e-8a87-c2ebffe407f6
                account_ids:
                  - '012345678911'
                  - '012345678912'
                  - '012345678913'
                  - '012345678914'
                  - '012345678915'
                  - '012345678916'
                discovery_rules:
                  - resource_details:
                      type: rds
                      action:
                        - rds-db:connect
                        - rds-db:connect
                    rules:
                      additionalProperties: resource_name_pattern
                  - resource_details:
                      type: rds
                      action:
                        - rds-db:connect
                        - rds-db:connect
                    rules:
                      additionalProperties: resource_name_pattern
                analysis_rules:
                  - rules:
                      excessive_user_access: '10'
                    '[object Object]': null
                created_at: '2023-08-25T12:00:00.000000Z'
                id: 5f3159e9-e7ab-428e-8a87-c2ebffe407f6
                status: COMPLETED
                updated_at: '2023-08-25T12:00:00.000000Z'
    delete:
      tags:
        - Cloud Infrastructure Entitlements
      summary: Delete a Cloud Entitlement Job
      description: |-
        Deletes an existing Cloud Entitlement Job

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: cloud_entitlement_analysis_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Cloud Entitlement Job
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/cloud_entitlement_analyses/{cloud_entitlement_analysis_id}/resources:
    post:
      tags:
        - Cloud Infrastructure Entitlements
      summary: List all Resources for a Cloud Entitlement Job
      description: >-
        Lists all resources discovered by a Cloud Entitlement Job. This list is
        sorted by risk.


        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content: {}
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: cloud_entitlement_analysis_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Cloud Entitlement Job
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
  /v1/teams/{team_name}/cloud_entitlement_analyses/{cloud_entitlement_analysis_id}/resources/{cloud_entitlement_summary_param}:
    get:
      tags:
        - Cloud Infrastructure Entitlements
      summary: Retrieve a Resource from a Cloud Entitlement Job
      description: |-
        Retrieves a specified Resource from a Cloud Entitlement Job

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: cloud_entitlement_analysis_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Cloud Entitlement Job
          example: <string>
        - name: cloud_entitlement_summary_param
          in: path
          schema:
            type: string
          required: true
          description: (Required) A specific param within a Cloud Entitlement Job
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: eu aliqua labore officia
                at_risk: false
                details:
                  name: laboris consectetur irure nisi dolor
                  account_id: sed veniam
                  region: mollit ullamco deserunt exercitation tempor
                  aws_id: quis sunt Excep
                  arn: molli
                  resource_id: fugiat
                  resource_type: rds
                  org_details:
                    orgid: in
                    name: Ut aliqua eu
                  children:
                    - id: officia nostrud id exercitation eu
                      name: enim consequat Excepteur
                      arn: culpa au
                    - id: consequat sint consectetur
                      name: ut com
                      arn: an
  /v1/teams/{team_name}/cloud_entitlement_analyses/{cloud_entitlement_analysis_id}/run:
    post:
      tags:
        - Cloud Infrastructure Entitlements
      summary: Run a Cloud Entitlement Job
      description: |-
        Runs the specified Cloud Entitlement Job

        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content: {}
      parameters:
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: cloud_entitlement_analysis_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Cloud Entitlement Job
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/cloud_entitlement_analyses/{cloud_entitlement_analysis_id}/summary:
    post:
      tags:
        - Cloud Infrastructure Entitlements
      summary: Retrieve a Cloud Entitlement Job Summary
      description: >-
        Retrieves a high-level summary of a previously run Cloud Entitlement
        Job. If the specified job doesn't have a status of `COMPLETED` or
        `ERROR`, this operation returns an empty response.


        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content: {}
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: cloud_entitlement_analysis_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Cloud Entitlement Job
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                status: COMPLETED
                last_updated_at: '2023-08-25T12:00:00.000000Z'
                errors:
                  message: eiusmod commodo dolor dolore est
                details:
                  resource_type: rds
                  resource_total_count: nostrud aliquip enim
                  resources_at_risk_count: 34930123
                  organization:
                    id: 5f3159e9-e7ab-428e-8a87-c2ebffe407f6
                    name: US West 2 Prod
  /v1/teams/{team_name}/gateway_setup_tokens:
    get:
      tags:
        - Gateways
      summary: List all Gateway Setup Tokens
      description: |-
        Lists all Gateway Setup Tokens for your Team

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: count
          in: query
          schema:
            type: string
          description: The number of objects per page
          example: <integer>
        - name: descending
          in: query
          schema:
            type: string
          description: The object order
          example: <boolean>
        - name: offset
          in: query
          schema:
            type: string
          description: >-
            The offset value for pagination. The **rel="next"** and
            **rel="prev"** `Link` headers define the offset for subsequent or
            previous pages.
          example: <string>
        - name: prev
          in: query
          schema:
            type: string
          description: The direction of paging
          example: <boolean>
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
                example: consectetur occaecat
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - id: b09ba4db-d5b4-4ec5-90da-188e1d13d467
                    registration_type: gateway-agent
                    description: Gateway Token 1
                    details:
                      labels:
                        region: NA-West
                    created_at: '2023-08-25T00:00:00Z'
                    token: >-
                      sft-gw.356c346c-256e-49d5-8db4-426426e066e4.eyJhdCI6ImZ5X2lZMnFmVk1TcHJQcDlUSEh0MS1SR240Rl9OOXZsSXEwUWhoNlNnSnciLCJhcyI6Imh0dHBzO0123GFtLXByb2R1Y3QtdGMxLnBhbS50cmV4Y2xvdWQuY29tposeL2FzL2FnZW50IiwicnMiOiJodHRwczovL3BhbS1wcm9kdWN0LXRjMS5wYW0udHJleGNsb3VkLmNvabc2MSJ9
                  - id: 0bcea2c6-8fd7-44f8-8125-eba8418a18d8
                    registration_type: gateway-agent
                    description: Gateway Token 2
                    details:
                      labels:
                        department: eng
                    created_at: '2023-08-25T00:00:00Z'
                    token: >-
                      sft-gw.342c346c-256e-49d5-8db4-426426e066e4.eyJhdCI6ImZ5X2lZMnFmVk1TcHJQcDlUSEh0MS1SR240ae9OOXZsSXEwUWhoNlNnSnciLCJhcyI6Imh0dHBzO0123GFtLXByb2R1Y3QtdGMxLnBhbS50cmV4Y2xvdWQuY29tposeL2FzL2FnZW50IiwicnMiOiJodHRwczovL3BhbS1wcm9kdWN0LXRjMS5wYW0udHJleGNsb3VkLmNvabc2MSyq
    post:
      tags:
        - Gateways
      summary: Create a Gateway Setup Token
      description: |-
        Creates a Gateway Setup Token for your Team

        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                registration_type: <string>
                details:
                  labels:
                    proident57: <string>
                    culpa77: <string>
                description: <string>
                name: <regex>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                registration_type: gateway-agent
                details:
                  labels:
                    commodo_64: <string>
                created_at: '2023-08-25T12:00:00.000000Z'
                description: Gateway Token 1
                id: b09ba4db-d5b4-4ec5-90da-188e1d13d467
                name: <regex>
                token: >-
                  sft-gw.342c346c-256e-49d5-8db4-426426eqe26e4.eyJhdCI6ImZ5X2lZMnFmVk1TcHJQcDlUSEh0MS1SR240ae9OOXZsSXEwUWhoNlNnSnciLCJhcyI6Imh0dHBzO0123GFtLXByb2R1Y3QtdGMxLnBhbS50cmV4Y2xvdWQuY29tposeL2FzL2FnZW50IiwicnMiOiJodHRwczovL3BhbS1wcm9kdWN0LXRjMS5wYW0udHJleGNsb3VkLmNvabc2MSyq
  /v1/teams/{team_name}/gateway_setup_tokens/{gateway_setup_token_id}:
    get:
      tags:
        - Gateways
      summary: Retrieve a Gateway Setup Token
      description: |-
        Retrieves the specified Gateway Setup Token

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: gateway_setup_token_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Gateway Setup Token
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                registration_type: gateway-agent
                details:
                  labels:
                    commodo_64: <string>
                created_at: '2023-08-25T12:00:00.000000Z'
                description: Gateway Token 1
                id: b09ba4db-d5b4-4ec5-90da-188e1d13d467
                name: <regex>
                token: >-
                  sft-gw.342c346c-256e-49d5-8db4-426426eqe26e4.eyJhdCI6ImZ5X2lZMnFmVk1TcHJQcDlUSEh0MS1SR240ae9OOXZsSXEwUWhoNlNnSnciLCJhcyI6Imh0dHBzO0123GFtLXByb2R1Y3QtdGMxLnBhbS50cmV4Y2xvdWQuY29tposeL2FzL2FnZW50IiwicnMiOiJodHRwczovL3BhbS1wcm9kdWN0LXRjMS5wYW0udHJleGNsb3VkLmNvabc2MSyq
    delete:
      tags:
        - Gateways
      summary: Delete a Gateway Setup Token
      description: |-
        Deletes the specified Gateway Setup Token

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: gateway_setup_token_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Gateway Setup Token
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/gateway_setup_tokens/{gateway_setup_token_id}/token:
    get:
      tags:
        - Gateways
      summary: Retrieve a Gateway Setup Token
      description: |-
        Retrieves the specified Gateway Setup Token

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: gateway_setup_token_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Gateway Setup Token
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                registration_type: gateway-agent
                details:
                  labels:
                    commodo_64: <string>
                created_at: '2023-08-25T12:00:00.000000Z'
                description: Gateway Token 1
                id: b09ba4db-d5b4-4ec5-90da-188e1d13d467
                name: <regex>
                token: >-
                  sft-gw.342c346c-256e-49d5-8db4-426426eqe26e4.eyJhdCI6ImZ5X2lZMnFmVk1TcHJQcDlUSEh0MS1SR240ae9OOXZsSXEwUWhoNlNnSnciLCJhcyI6Imh0dHBzO0123GFtLXByb2R1Y3QtdGMxLnBhbS50cmV4Y2xvdWQuY29tposeL2FzL2FnZW50IiwicnMiOiJodHRwczovL3BhbS1wcm9kdWN0LXRjMS5wYW0udHJleGNsb3VkLmNvabc2MSyq
  /v1/teams/{team_name}/gateways:
    get:
      tags:
        - Gateways
      summary: List all Gateways
      description: >-
        Lists all Gateways for your Team


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: contains
          in: query
          schema:
            type: string
          description: Only return results that include the specified value
          example: <string>
        - name: count
          in: query
          schema:
            type: string
          description: The number of objects per page
          example: <integer>
        - name: descending
          in: query
          schema:
            type: string
          description: The object order
          example: <boolean>
        - name: offset
          in: query
          schema:
            type: string
          description: >-
            The offset value for pagination. The **rel="next"** and
            **rel="prev"** `Link` headers define the offset for subsequent or
            previous pages.
          example: <string>
        - name: prev
          in: query
          schema:
            type: string
          description: The direction of paging
          example: <boolean>
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
                example: consectetur occaecat
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - id: napa5791-fc26-4386-93f4-eca6a157ew15
                    name": Production gateway
                    access_address: 192.168.190.144:7234
                    default_address: 192.168.19.32
                    description: Gateway used for prod env
                    cloud_provider: null
                    refuse_connections: false
                    labels:
                      property1: string
                      property2: string
                    last_seen: '2023-08-25T13:00:00.000000Z'
                  - id: 7cdac13d-a3fe-43e8-9a41-13b15df97fc7
                    name: Dev Gateway
                    access_address: 192.168.190.145:7234
                    default_address: 192.168.19.33
                    description: Gateway used for dev env
                    cloud_provider: null
                    refuse_connections: false
                    labels:
                      property1: string
                      property2: string
                    last_seen: '2023-08-25T14:35:00.000000Z'
  /v1/teams/{team_name}/gateways/{gateway_id}:
    get:
      tags:
        - Gateways
      summary: Retrieve a Gateway
      description: >-
        Retrieves the properties of a specified Gateway


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: gateway_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Gateway
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: e1403075-008e-17e5-871d-758a98c42289
                name: S
                refuse_connections: false
                labels:
                  cillum_7eb: et Lorem dolore nostrud
                  adipisicing_d71: aute minim
                access_address: 192.168.190.144:7234
                cloud_provider: aws
                default_address: 192.168.19.32
                description: sit ea
                last_seen: '2023-08-25T13:00:00.000000Z'
    put:
      tags:
        - Gateways
      summary: Update a Gateway
      description: |-
        Updates a specified Gateway

        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <regex>
                labels:
                  irure81b: <string>
                  dolore6: <string>
                access_address: <string>
                default_address: <string>
                description: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: gateway_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Gateway
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
    delete:
      tags:
        - Gateways
      summary: Delete a Gateway
      description: |-
        Deletes the specified Gateway from your Team

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: gateway_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Gateway
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/gateways/{gateway_id}/status:
    get:
      tags:
        - Gateways
      summary: Retrieve a status report for a Gateway
      description: >-
        Retrieve a status report for the specified Gateway


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: gateway_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Gateway
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                active_connections: 2
                gateway_id: 3b0fdbdd-1282-440d-a973-ddc409d6d743
                status: ONLINE
                total_storage_bytes: 4096
                updated_at: '0001-01-01T00:00:00Z'
                used_storage_bytes: 2048
  /v1/teams/{team_name}/groups:
    get:
      tags:
        - Groups
      summary: List all Groups for a Team
      description: >-
        Lists all Groups for your Team


        This endpoint requires one of the following roles: `pam_admin`,
        `resource_admin`, `delegated_resource_admin`, `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: contains
          in: query
          schema:
            type: string
          description: Only return results that include the specified value
          example: <string>
        - name: count
          in: query
          schema:
            type: string
          description: The number of objects per page
          example: <integer>
        - name: descending
          in: query
          schema:
            type: string
          description: The object order
          example: <boolean>
        - name: id
          in: query
          schema:
            type: string
          description: Only return results with the specified IDs
          example: <string>
        - name: ignore
          in: query
          schema:
            type: string
          description: Ignore Groups with the specified names. This is case sensitive.
          example: <string>
        - name: include_deleted
          in: query
          schema:
            type: string
          description: If `true`, include deleted Groups in the results
          example: <boolean>
        - name: offset
          in: query
          schema:
            type: string
          description: >-
            The offset value for pagination. The **rel="next"** and
            **rel="prev"** `Link` headers define the offset for subsequent or
            previous pages.
          example: <string>
        - name: only_include_deleted
          in: query
          schema:
            type: string
          description: If `true`, only return deleted Groups in the results
          example: <boolean>
        - name: prev
          in: query
          schema:
            type: string
          description: The direction of paging
          example: <boolean>
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
                example: consectetur occaecat
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - id: 6783cefe-b243-4c59-a0a2-5839d2c873fb
                    name: compsons
                    roles:
                      - pam_admin
                      - resource_admin
                    deleted_at: '0001-01-01T00:00:00Z'
                  - id: b5a346c5-bafa-40eb-bb9f-401c0f57db36
                    name: compsons
                    roles:
                      - pam_admin
                      - resource_admin
                    deleted_at: '0001-01-01T00:00:00Z'
    post:
      tags:
        - Groups
      summary: Create a Group
      description: >-
        Creates a Group for your Team. Groups allow you to assign RBAC roles to
        users and manage user access to Resource Groups and Projects. To assign
        the `delegated_resource_admin` role, you need to add the Group to the
        `delegated_resource_admin_groups` list for a specific Resource Group.
        See [Resource Groups](/openapi/opa/tag/resource-groups).


        This endpoint requires the following role: `pam_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <string>
                roles:
                  - <string>
                  - <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                deleted_at: '0001-01-01T00:00:00Z'
                id: b5a346c5-bafa-40eb-bb9f-401c0f57db36
                name: compsons
                roles:
                  - pam_admin
                  - resource_admin
  /v1/teams/{team_name}/groups/{group_name}:
    get:
      tags:
        - Groups
      summary: Retrieve a Group
      description: >-
        Retrieves a specified Group


        This endpoint requires one of the following roles: `pam_admin`,
        `resource_admin`, `delegated_resource_admin`, `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: group_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of a Group
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                deleted_at: '0001-01-01T00:00:00Z'
                id: b5a346c5-bafa-40eb-bb9f-401c0f57db36
                name: compsons
                roles:
                  - pam_admin
                  - resource_admin
    put:
      tags:
        - Groups
      summary: Update a Group
      description: >-
        Updates the access privileges of the specified Group. To assign the
        `delegated_resource_admin` role, you need to add the Group to the
        `delegated_resource_admin_groups` list for a specific Resource Group.
        See [Resource Groups](/openapi/opa/tag/resource-groups).


        This endpoint requires the following role: `pam_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                roles:
                  - <string>
                  - <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: group_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of a Group
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
    delete:
      tags:
        - Groups
      summary: Delete a Group from a Team
      description: >-
        Removes a Group from your Team. This also removes the Group from any
        associated Projects.


        This endpoint requires the following role: `pam_admin`.
      parameters:
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: group_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of a Group
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/groups/{group_name}/users:
    get:
      tags:
        - Groups
      summary: List all Users for a Group
      description: >-
        Lists all Users in a specified Group


        This endpoint requires one of the following roles: `pam_admin`,
        `resource_admin`, `delegated_resource_admin`, `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: contains
          in: query
          schema:
            type: string
          description: Only return results that include the specified value
          example: <string>
        - name: count
          in: query
          schema:
            type: string
          description: The number of objects per page
          example: <integer>
        - name: descending
          in: query
          schema:
            type: string
          description: The object order
          example: <boolean>
        - name: offset
          in: query
          schema:
            type: string
          description: >-
            The offset value for pagination. The **rel="next"** and
            **rel="prev"** `Link` headers define the offset for subsequent or
            previous pages.
          example: <string>
        - name: prev
          in: query
          schema:
            type: string
          description: The direction of paging
          example: <boolean>
        - name: starts_with
          in: query
          schema:
            type: string
          description: Only return Users with a name that begins with the specified value
          example: <string>
        - name: status
          in: query
          schema:
            type: string
          description: >-
            Only return Users with the specified status. Valid statuses:
            `ACTIVE`, `DISABLED`, and `DELETED`.
          example: <string>
        - name: user_type
          in: query
          schema:
            type: string
          description: >-
            Only return Users of the specified type. Valid types: `human` and
            `service`.
          example: <string>
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: group_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of a Group
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
                example: consectetur occaecat
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - team_name: william-faulkner
                    id: c5cf4dfd-1726-45e3-a1c9-17598d59004d
                    name: Benjy.Compson
                    status: DISABLED
                    details:
                      first_name: Benjy
                      last_name: Compson
                      full_name: Benjy Compson
                      email: benjy.compson@example.com
                    user_type: human
                    deleted_at: null
    post:
      tags:
        - Groups
      summary: Add a User to a Group
      description: |-
        Adds a User to a Group

        This endpoint requires the following role: `pam_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: group_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of a Group
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/groups/{group_name}/users/{user_name}:
    delete:
      tags:
        - Groups
      summary: Remove a User from a Group
      description: |-
        Removes a User from a Group

        This endpoint requires the following role: `pam_admin`.
      parameters:
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: group_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of a Group
          example: <string>
        - name: user_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The username for an existing User
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects:
    get:
      tags:
        - Projects
      summary: List all Projects in a Resource Group
      description: >-
        Lists all Projects in the specified Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
    post:
      tags:
        - Projects
      summary: Create a Project in a Resource Group
      description: >-
        Creates a Project in the specified Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <regex>
                active_resource_count: <integer>
                create_server_users: <boolean>
                force_shared_ssh_users: <boolean>
                gateway_selector: <string>
                next_unix_gid: <integer>
                next_unix_uid: <integer>
                persistent_server_user_accounts: null
                require_preauth_for_creds: <boolean>
                resource_group_id: <string>
                server_account_management: <boolean>
                shared_admin_user_name: <string>
                shared_standard_user_name: <string>
                ssh_certificate_type: <string>
                stale_resource_count: <integer>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                '0': {}
                '1': {}
                '2': {}
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}:
    get:
      tags:
        - Projects
      summary: Retrieve a Project from a Resource Group
      description: >-
        Retrieves a Project from a Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: <regex>
                active_resource_count: 50
                create_server_users: <boolean>
                deleted_at: '1997-04-21T19:15:58.836Z'
                force_shared_ssh_users: <boolean>
                gateway_selector: REGION=WEST-EU,TEAM=MARKETING
                id: 4b2b1d06-b4b1-4e36-b596-70737300d69d
                next_unix_gid: <integer>
                next_unix_uid: <integer>
                persistent_server_user_accounts: null
                require_preauth_for_creds: <boolean>
                resource_group_id: 5f3159e9-e7ab-428e-8a87-c2ebffe407f6
                server_account_management: <boolean>
                shared_admin_user_name: Server.Admin
                shared_standard_user_name: Server.User
                ssh_certificate_type: CERT_TYPE_ED25519_01
                stale_resource_count: 0
                team: Your_OPA_Team
                user_on_demand_period: 1005959238
    put:
      tags:
        - Projects
      summary: Update a Project in a Resource Group
      description: >-
        Updates a Project in a Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <regex>
                active_resource_count: <integer>
                create_server_users: <boolean>
                force_shared_ssh_users: <boolean>
                gateway_selector: <string>
                next_unix_gid: <integer>
                next_unix_uid: <integer>
                persistent_server_user_accounts: null
                require_preauth_for_creds: <boolean>
                resource_group_id: <string>
                server_account_management: <boolean>
                shared_admin_user_name: <string>
                shared_standard_user_name: <string>
                ssh_certificate_type: <string>
                stale_resource_count: <integer>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                name: <regex>
                active_resource_count: 50
                create_server_users: <boolean>
                deleted_at: '1997-04-21T19:15:58.836Z'
                force_shared_ssh_users: <boolean>
                gateway_selector: REGION=WEST-EU,TEAM=MARKETING
                id: 4b2b1d06-b4b1-4e36-b596-70737300d69d
                next_unix_gid: <integer>
                next_unix_uid: <integer>
                persistent_server_user_accounts: null
                require_preauth_for_creds: <boolean>
                resource_group_id: 5f3159e9-e7ab-428e-8a87-c2ebffe407f6
                server_account_management: <boolean>
                shared_admin_user_name: Server.Admin
                shared_standard_user_name: Server.User
                ssh_certificate_type: CERT_TYPE_ED25519_01
                stale_resource_count: 0
                team: Your_OPA_Team
                user_on_demand_period: 1005959238
    delete:
      tags:
        - Projects
      summary: Delete a Project from a Resource Group
      description: >-
        Deletes a Project from a Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_accounts:
    get:
      tags:
        - Projects
      summary: List all Server Accounts in a Project
      description: >-
        Lists all Server Accounts in a Resource Group Project


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_accounts/{server_account_id}:
    get:
      tags:
        - Projects
      summary: Retrieve a Server Account
      description: >-
        Retrieves a Server Account from a Project in a Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
        - name: server_account_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Server Account
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                items:
                  created_at: '2002-05-24T07:27:02.995Z'
                  deleted_at: '1987-11-17T04:51:56.748Z'
                  hostname: incididunt ullamco enim ut
                  id: ipsum ut adipisicing tempor quis
                  last_password_change_error_metadata: sed anim dolore
                  last_password_change_error_report_timestamp: '1948-07-18T23:31:59.732Z'
                  last_password_change_error_system_timestamp: '1974-06-16T02:20:41.703Z'
                  last_password_change_error_type: deserunt eiusmod
                  last_password_change_success_report_timestamp: '2020-11-17T12:55:05.292Z'
                  last_password_change_system_timestamp: '2021-05-10T07:42:25.692Z'
                  login: amet tempor laboris ut
                  managed: true
                  project_id: aliqua consectetur
                  server_id: consectetur sit
                  team_id: eiusmod nisi et ut
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_enrollment_tokens:
    get:
      tags:
        - Projects
      summary: List all Server Enrollment Tokens in a Project
      description: >-
        Lists all Server Enrollment Tokens in a Resource Group Project


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
    post:
      tags:
        - Projects
      summary: Create a Server Enrollment Token
      description: >-
        Creates a Server Enrollment Token for a Project in a Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                description: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                description: <string>
                created_by_user: aliqua velit pariatur
                id: 5298e58f-c009-3c3d-ae2f-aa1e248d5317
                issued_at: '2021-05-17T06:36:14.036Z'
                token:
                  essea: ipsum dolor dolore
                  quis_e7: elit
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_enrollment_tokens/{server_enrollment_token_id}:
    get:
      tags:
        - Projects
      summary: Retrieve a Server Enrollment Token
      description: >-
        Retrieves a Server Enrollment Token from a Project in a Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
        - name: server_enrollment_token_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Server Enrollment Token
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                description: <string>
                created_by_user: aliqua velit pariatur
                id: 5298e58f-c009-3c3d-ae2f-aa1e248d5317
                issued_at: '2021-05-17T06:36:14.036Z'
                token:
                  essea: ipsum dolor dolore
                  quis_e7: elit
    delete:
      tags:
        - Projects
      summary: Delete a Server Enrollment Token
      description: >-
        Deletes a Server Enrollment Token from a Project in a Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
        - name: server_enrollment_token_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Server Enrollment Token
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/server_password_settings:
    get:
      tags:
        - Projects
      summary: Retrieve Project Password Policy for Server Accounts
      description: >-
        Retrieves a Password Policy for a Project in a Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                enable_periodic_rotation: true
                min_length_in_bytes: 8056662
                max_length_in_bytes: -16183254
                character_options:
                  upper_case: false
                  lower_case: true
                  digits: false
                  punctuation: true
                  require_from_each_set: false
                managed_privileged_accounts_config:
                  - dolor quis dolore
                  - veniam ea Duis
                modified_at: '1999-10-22T16:19:01.837Z'
                periodic_rotation_duration_in_seconds: 17379927
    put:
      tags:
        - Projects
      summary: Update Project Password Policy for Server Accounts
      description: >-
        Updates a Password Policy for a Project in a Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                enable_periodic_rotation: <boolean>
                min_length_in_bytes: <integer>
                max_length_in_bytes: <integer>
                character_options:
                  upper_case: <boolean>
                  lower_case: <boolean>
                  digits: <boolean>
                  punctuation: <boolean>
                  require_from_each_set: <boolean>
                managed_privileged_accounts_config:
                  - <string>
                  - <string>
                periodic_rotation_duration_in_seconds: <integer>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                enable_periodic_rotation: <boolean>
                min_length_in_bytes: <integer>
                max_length_in_bytes: <integer>
                character_options:
                  upper_case: <boolean>
                  lower_case: <boolean>
                  digits: <boolean>
                  punctuation: <boolean>
                  require_from_each_set: <boolean>
                managed_privileged_accounts_config:
                  - <string>
                  - <string>
                modified_at: '2005-08-02T10:08:00.330Z'
                periodic_rotation_duration_in_seconds: <integer>
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/servers/{server_id}/server_accounts:
    get:
      tags:
        - Projects
      summary: List all Server Accounts for a Server
      description: >-
        Lists all Server Accounts for a Server in a Project


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
        - name: server_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of an enrolled Server
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
  /v1/teams/{team_name}/access_reports:
    get:
      tags:
        - Access Reports
      summary: List all Access Reports
      description: |-
        Lists all Access Reports

        This endpoint requires the following role: `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
    post:
      tags:
        - Access Reports
      summary: Create an Access Report
      description: >-
        Create an Access Report. Each report must be connected to a specific
        User or Resource.


        This endpoint requires the following role: `security_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                user:
                  id: <regex>
                  resource_type_filter: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created_at: '2023-08-25T12:00:00.000000Z'
                details:
                  user:
                    id: 5fdf5ae9-e4db-4aae-8127-c2ebffe747f6
                    resource_type_filter: <string>
                id: 5fdf5ae9-e71b-423e-8a87-c2ebffe407f6
                status: COMPLETED
                updated_at: '2023-08-25T12:00:00.000000Z'
  /v1/teams/{team_name}/access_reports/{access_report_id}:
    get:
      tags:
        - Access Reports
      summary: Retrieve an Access Report
      description: |-
        Retrieve the metadata of the specified Access Report

        This endpoint requires the following role: `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: access_report_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of an Access Report
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                created_at: '2023-08-25T12:00:00.000000Z'
                details:
                  user:
                    id: 5fdf5ae9-e4db-4aae-8127-c2ebffe747f6
                    resource_type_filter: <string>
                id: 5fdf5ae9-e71b-423e-8a87-c2ebffe407f6
                status: COMPLETED
                updated_at: '2023-08-25T12:00:00.000000Z'
  /v1/teams/{team_name}/access_reports/{access_report_id}/report:
    get:
      tags:
        - Access Reports
      summary: Download an Access Report
      description: >-
        Downloads the specific Access Report for review. The CSV formatted
        report is included in the response.


        This endpoint requires the following role: `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: text/csv
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: access_report_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of an Access Report
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: text/csv
          content:
            text/plain:
              schema:
                type: string
              example: proident dolore ea sit
  /v1/teams/{team_name}/resource_groups:
    get:
      tags:
        - Resource Groups
      summary: List all Resource Groups
      description: >-
        Lists all Resource Groups available to the requesting User


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - id: 9c199afe-0ca5-427a-baac-c4341707d82b
                    name: OPA_Resource_Group_1
                    team_id: Your_Team
                    description: A sensible description
                  - id: 9c199afe-0ca5-427a-baac-c4341707d123
                    name: OPA_Resource_Group_2
                    team_id: Your_Team
                    description: A sensible description
    post:
      tags:
        - Resource Groups
      summary: Create a Resource Group
      description: >-
        Creates a Resource Group for your Team. To assign the
        `delegated_resource_admin` role, specify an existing Group in the
        `delegated_resource_admin_groups` param.


        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                delegated_resource_admin_groups:
                  - id: <string>
                  - id: <string>
                description: <string>
                name: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                delegated_resource_admin_groups:
                  - id: <string>
                    name: Excepteur laborum anim cillum
                    type: secret
                  - id: <string>
                    name: quis labore aute sed
                    type: secret
                description: <string>
                id: id non enim
                name: <string>
                team_id: ad nulla Excepteur sit
  /v1/teams/{team_name}/resource_groups/{resource_group_id}:
    get:
      tags:
        - Resource Groups
      summary: Retrieve a Resource Group
      description: >-
        Retrieves the specified Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                delegated_resource_admin_groups:
                  - id: <string>
                    name: Excepteur laborum anim cillum
                    type: secret
                  - id: <string>
                    name: quis labore aute sed
                    type: secret
                description: <string>
                id: id non enim
                name: <string>
                team_id: ad nulla Excepteur sit
    put:
      tags:
        - Resource Groups
      summary: Update a Resource Group
      description: >-
        Updates the specified Resource Group. To assign the
        `delegated_resource_admin` role, specify an existing Group in the
        `delegated_resource_admin_groups` param.


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                delegated_resource_admin_groups:
                  - id: <string>
                  - id: <string>
                description: <string>
                name: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                delegated_resource_admin_groups:
                  - id: <string>
                    name: Excepteur laborum anim cillum
                    type: secret
                  - id: <string>
                    name: quis labore aute sed
                    type: secret
                description: <string>
                id: id non enim
                name: <string>
                team_id: ad nulla Excepteur sit
    delete:
      tags:
        - Resource Groups
      summary: Delete a Resource Group
      description: |-
        Deletes the specified Resource Group

        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/resolve_secret:
    post:
      tags:
        - Secrets
      summary: Resolve Secret or Folder
      description: >-
        Resolves the ID or path for a Secret or Secret Folder. Users must be
        authorized to perform this action by an existing Security Policy.


        To resolve the ID, the request must include the named path. To resolve
        the path, the request must include the ID.


        This endpoint requires one of the following roles:
        `authenticated_client`, `authenticated_service_user`, `security_admin`,
        `delegated_security_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                resource_group:
                  id: <string>
                  name: <string>
                project:
                  id: <string>
                  name: <string>
                id: <string>
                parent_folder_path: <string>
                secret_folder_name: <string>
                secret_name: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: cillum nisi in velit
                name: ad dolor exercitation
                resource_group:
                  id: <string>
                  name: adipisicing deserunt Duis Lorem dolore
                  type: resource_group
                project:
                  id: <string>
                  name: aliquip laboris anim officia ullamco
                  type: secret
                description: dolor consequat
                path:
                  - id: qui laborum incididunt
                    name: consectetur magna sunt proident
                  - id: ipsum in
                    name: non incididunt do
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secret_folders:
    get:
      tags:
        - Secrets
      summary: List top-level Secret Folders for a Project
      description: >-
        Lists all top-level Secret Folders for a Project. Users must be
        authorized to perform this action by an existing Security Policy.


        This endpoint requires the following roles: `authenticated_client`,
        `authenticated_service_user`, `end_user`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
    post:
      tags:
        - Secrets
      summary: Create a Secret Folder
      description: >-
        Creates a Secret Folder. Users must be authorized to perform this action
        by an existing Security Policy.


        This endpoint requires the following roles: `authenticated_client`,
        `authenticated_service_user`, `end_user`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <string>
                description: <string>
                parent_folder_id: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: nostrud ipsum elit
                name: occaecat in dolor non
                description: do
                path:
                  - id: enim culpa dolo
                    name: ullamco ut nostrud
                  - id: dolore
                    name: ad qui aute exercitation
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secret_folders/{secret_folder_id}:
    get:
      tags:
        - Secrets
      summary: Retrieve a Secret Folder
      description: >-
        Retrieves the specified Secret Folder. Users must be authorized to
        perform this action by an existing Security Policy.


        This endpoint requires the following roles: `authenticated_client`,
        `authenticated_service_user`, `end_user`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
        - name: secret_folder_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Secret Folder
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: ''
                name: sed fugiat dolor sint nisi
                description: voluptate cillum rep
                path:
                  - id: exercitation aute est culpa
                    name: ut cillum
                  - id: cupidatat velit elit
                    name: magna incididunt
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
    put:
      tags:
        - Secrets
      summary: Update a Secret Folder
      description: >-
        Updates the specified Secret Folder. Users must be authorized to perform
        this action by an existing Security Policy.


        This endpoint requires the following roles: `authenticated_client`,
        `authenticated_service_user`, `end_user`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <string>
                description: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
        - name: secret_folder_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Secret Folder
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: ''
                name: sed fugiat dolor sint nisi
                description: voluptate cillum rep
                path:
                  - id: exercitation aute est culpa
                    name: ut cillum
                  - id: cupidatat velit elit
                    name: magna incididunt
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
    delete:
      tags:
        - Secrets
      summary: Delete a Secret Folder
      description: >-
        Deletes the specified Secret Folder. Users must be authorized to perform
        this action by an existing Security Policy.


        This endpoint requires the following roles: `authenticated_client`,
        `authenticated_service_user`, `end_user`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
        - name: secret_folder_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Secret Folder
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secret_folders/{secret_folder_id}/items:
    get:
      tags:
        - Secrets
      summary: List all items in a Secret Folder
      description: >-
        Lists all items in a Secret Folder. Users must be authorized to perform
        this action by an existing Security Policy.


        This endpoint requires the following roles: `authenticated_client`,
        `authenticated_service_user`, `end_user`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: count
          in: query
          schema:
            type: string
          description: The number of objects per page
          example: <integer>
        - name: descending
          in: query
          schema:
            type: string
          description: The object order
          example: <boolean>
        - name: offset
          in: query
          schema:
            type: string
          description: >-
            The offset value for pagination. The **rel="next"** and
            **rel="prev"** `Link` headers define the offset for subsequent or
            previous pages.
          example: <string>
        - name: prev
          in: query
          schema:
            type: string
          description: The direction of paging
          example: <boolean>
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
        - name: secret_folder_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Secret Folder
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets:
    post:
      tags:
        - Secrets
      summary: Create a Secret
      description: >-
        Creates a Secret. Users must be authorized to perform this action by an
        existing Security Policy.


        This endpoint requires one of the following roles:
        `authenticated_client`, `authenticated_service_user`, `end_user`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <string>
                secret_jwe: <string>
                parent_folder_id: <string>
                description: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: in pariatur
                name: enim
                description: cillum dolor id
                path:
                  - id: veniam nos
                    name: aliqui
                  - id: reprehenderit ea aliqua
                    name: mi
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/secrets/{secret_id}:
    get:
      tags:
        - Secrets
      summary: Retrieve a Secret
      description: >-
        Retrieves the specified Secret. Users must be authorized to perform this
        action by an existing Security Policy.


        This endpoint requires one of the following roles:
        `authenticated_client`, `authenticated_service_user`, `end_user`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
        - name: secret_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Secret
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: veniam laboris irure
                name: fugiat in reprehenderit amet minim
                description: proident tempor consectetur ipsum
                path:
                  - id: Ut es
                    name: ipsum veniam eu
                  - id: elit quis eu incididunt
                    name: consectetur ea adipisicing Duis
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
    post:
      tags:
        - Secrets
      summary: Reveal a Secret
      description: >-
        Reveals the specified Secret. Users must be authorized to perform this
        action by an existing Security Policy.


        This endpoint requires one of the following roles:
        `authenticated_client`, `authenticated_service_user`, `end_user`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                public_key:
                  alg: <string>
                  crv: <string>
                  d: <byte>
                  dp: <byte>
                  dq: <byte>
                  e: <byte>
                  k: <byte>
                  kid: <regex>
                  kty: <string>
                  'n': <byte>
                  p: <byte>
                  q: <byte>
                  qi: <byte>
                  use: <string>
                  x: <byte>
                  x5c:
                    - <string>
                    - <string>
                  x5t: <string>
                  x5t#S256: <string>
                  x5u: <string>
                  'y': <byte>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
        - name: secret_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Secret
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: eiusmod
                name: elit id
                secret_jwe: aliqua labore
                description: Duis velit dolor est
                path:
                  - id: dolore exercitation commodo sint
                    name: cillum reprehenderit voluptate
                  - id: labore n
                    name: deserunt eiusmod fugiat est adipisicing
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
    put:
      tags:
        - Secrets
      summary: Update a Secret
      description: >-
        Updates the specified Secret. Users must be authorized to perform this
        action by an existing Security Policy.


        This endpoint requires one of the following roles:
        `authenticated_client`, `authenticated_service_user`, `end_user`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <string>
                secret_jwe: <string>
                parent_folder_id: <string>
                description: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
        - name: secret_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Secret
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: veniam laboris irure
                name: fugiat in reprehenderit amet minim
                description: proident tempor consectetur ipsum
                path:
                  - id: Ut es
                    name: ipsum veniam eu
                  - id: elit quis eu incididunt
                    name: consectetur ea adipisicing Duis
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
    delete:
      tags:
        - Secrets
      summary: Delete a Secret
      description: >-
        Deletes the specified Secret. Users must be authorized to perform this
        action by an existing Security Policy.


        This endpoint requires one of the following roles:
        `authenticated_client`, `authenticated_service_user`, `end_user`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
        - name: secret_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Secret
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
        '403':
          description: Forbidden
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
  /v1/teams/{team_name}/secret_folders:
    get:
      tags:
        - Secrets
      summary: List top-level Secret Folders for Team
      description: |-
        Lists all top-level Secret Folders for a Team

        This endpoint requires the following roles: `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
  /v1/teams/{team_name}/secrets:
    get:
      tags:
        - Secrets
      summary: List top-level Secret Folders for User
      description: >-
        Lists all top-level Secret Folders for a User. Users must be authorized
        to perform this action by an existing Security Policy.


        This endpoint requires one of the following roles:
        `authenticated_client`, `authenticated_service_user`, `end_user`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: count
          in: query
          schema:
            type: string
          description: The number of objects per page
          example: <integer>
        - name: descending
          in: query
          schema:
            type: string
          description: The object order
          example: <boolean>
        - name: offset
          in: query
          schema:
            type: string
          description: >-
            The offset value for pagination. The **rel="next"** and
            **rel="prev"** `Link` headers define the offset for subsequent or
            previous pages.
          example: <string>
        - name: prev
          in: query
          schema:
            type: string
          description: The direction of paging
          example: <boolean>
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
  /v1/teams/{team_name}/security_policy:
    get:
      tags:
        - Security Policy
      summary: List all Security Policies
      description: |-
        Lists all Security Policies for the current Security Admin

        This endpoint requires the following role: `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - id: 123-456-789
                    name: SecurityPolicy1
                    description: string
                    active: true
                    principals:
                      user_groups:
                        - id: 6c88b11b-b4ad-436b-a69a-c11dy08q7155
                          name: An_OPA_Group
                          type: user_group
                    rules:
                      - name: Rule1
                        resource_type: server_based_resource
                        resource_selector:
                          selectors:
                            - selector_type: individual_server
                              selector:
                                server_id:
                                  id: 145-321-098
                                  name: Foo
                                  type: server
                        privileges:
                          - privilege_type: password_checkout_ssh
                            privilege_value:
                              password_checkout_ssh: true
                          - privilege_type: principal_account_ssh
                            privilege_value:
                              principal_account_ssh: true
                        conditions:
                          - condition_type: access_request
                            condition_value:
                              request_type_id: 641e0d0d71a122005709ca51
                              request_type_name: New Test
                              expires_after_seconds: 900
                          - condition_type: gateway
                            condition_value:
                              traffic_forwarding: true
                              session_recording: true
                          - condition_type: mfa
                            condition_value:
                              re_auth_frequency_in_seconds: '3600'
                              acr_values: urn:okta:loa:2fa:any
                        security_policy_id: string
    post:
      tags:
        - Security Policy
      summary: Create a Security Policy
      description: |-
        Creates a Security Policy

        This endpoint requires the following role: `security_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <string>
                description: <string>
                active: <boolean>
                principals:
                  user_groups:
                    - id: <string>
                    - id: <string>
                rules:
                  - name: <string>
                    resource_type: <string>
                    resource_selector:
                      selectors:
                        - selector:
                            server:
                              id: <string>
                          selector_type: <string>
                        - selector:
                            server:
                              id: <string>
                          selector_type: <string>
                    privileges:
                      - privilege_type: <string>
                        privilege_value: <object>
                      - privilege_type: <string>
                        privilege_value: <object>
                    conditions:
                      - condition_type: <string>
                        condition_value:
                          expires_after_seconds: <integer>
                          request_type_name: <string>
                      - condition_type: <string>
                        condition_value:
                          expires_after_seconds: <integer>
                          request_type_name: <string>
                  - name: <string>
                    resource_type: <string>
                    resource_selector:
                      selectors:
                        - selector:
                            server:
                              id: <string>
                          selector_type: <string>
                        - selector:
                            server:
                              id: <string>
                          selector_type: <string>
                    privileges:
                      - privilege_type: <string>
                        privilege_value: <object>
                      - privilege_type: <string>
                        privilege_value: <object>
                    conditions:
                      - condition_type: <string>
                        condition_value:
                          expires_after_seconds: <integer>
                          request_type_name: <string>
                      - condition_type: <string>
                        condition_value:
                          expires_after_seconds: <integer>
                          request_type_name: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 123-456-789
                name: SecurityPolicy1
                description: string
                active: true
                principals:
                  user_groups:
                    - id: 6c88b11b-b4ad-436b-a69a-c11dy08q7155
                      name: An_OPA_Group
                      type: user_group
                rules:
                  - name: Rule1
                    resource_type: server_based_resource
                    resource_selector:
                      selectors:
                        - selector_type: individual_server
                          selector:
                            server_id:
                              id: 145-321-098
                              name: Foo
                              type: server
                    privileges:
                      - privilege_type: password_checkout_ssh
                        privilege_value:
                          password_checkout_ssh: true
                      - privilege_type: principal_account_ssh
                        privilege_value:
                          principal_account_ssh: true
                    conditions:
                      - condition_type: access_request
                        condition_value:
                          request_type_id: 641e0d0d71a122005709ca51
                          request_type_name: New Test
                          expires_after_seconds: 900
                      - condition_type: gateway
                        condition_value:
                          traffic_forwarding: true
                          session_recording: true
                      - condition_type: mfa
                        condition_value:
                          re_auth_frequency_in_seconds: '3600'
                          acr_values: urn:okta:loa:2fa:any
                    security_policy_id: string
  /v1/teams/{team_name}/security_policy/{security_policy_id}:
    get:
      tags:
        - Security Policy
      summary: Retrieve a Security Policy
      description: |-
        Retrieves the specified Security Policy

        This endpoint requires the following role: `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: security_policy_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Security Policy
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 123-456-789
                name: SecurityPolicy1
                description: string
                active: true
                principals:
                  user_groups:
                    - id: 6c88b11b-b4ad-436b-a69a-c11dy08q7155
                      name: An_OPA_Group
                      type: user_group
                rules:
                  - name: Rule1
                    resource_type: server_based_resource
                    resource_selector:
                      selectors:
                        - selector_type: individual_server
                          selector:
                            server_id:
                              id: 145-321-098
                              name: Foo
                              type: server
                    privileges:
                      - privilege_type: password_checkout_ssh
                        privilege_value:
                          password_checkout_ssh: true
                      - privilege_type: principal_account_ssh
                        privilege_value:
                          principal_account_ssh: true
                    conditions:
                      - condition_type: access_request
                        condition_value:
                          request_type_id: 641e0d0d71a122005709ca51
                          request_type_name: New Test
                          expires_after_seconds: 900
                      - condition_type: gateway
                        condition_value:
                          traffic_forwarding: true
                          session_recording: true
                      - condition_type: mfa
                        condition_value:
                          re_auth_frequency_in_seconds: '3600'
                          acr_values: urn:okta:loa:2fa:any
                    security_policy_id: string
    put:
      tags:
        - Security Policy
      summary: Update a Security Policy
      description: |-
        Updates the specified Security Policy

        This endpoint requires the following role: `security_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <string>
                description: <string>
                active: <boolean>
                principals:
                  user_groups:
                    - id: <string>
                    - id: <string>
                rules:
                  - name: <string>
                    resource_type: <string>
                    resource_selector:
                      selectors:
                        - selector:
                            server:
                              id: <string>
                          selector_type: <string>
                        - selector:
                            server:
                              id: <string>
                          selector_type: <string>
                    privileges:
                      - privilege_type: <string>
                        privilege_value: <object>
                      - privilege_type: <string>
                        privilege_value: <object>
                    conditions:
                      - condition_type: <string>
                        condition_value:
                          expires_after_seconds: <integer>
                          request_type_name: <string>
                      - condition_type: <string>
                        condition_value:
                          expires_after_seconds: <integer>
                          request_type_name: <string>
                  - name: <string>
                    resource_type: <string>
                    resource_selector:
                      selectors:
                        - selector:
                            server:
                              id: <string>
                          selector_type: <string>
                        - selector:
                            server:
                              id: <string>
                          selector_type: <string>
                    privileges:
                      - privilege_type: <string>
                        privilege_value: <object>
                      - privilege_type: <string>
                        privilege_value: <object>
                    conditions:
                      - condition_type: <string>
                        condition_value:
                          expires_after_seconds: <integer>
                          request_type_name: <string>
                      - condition_type: <string>
                        condition_value:
                          expires_after_seconds: <integer>
                          request_type_name: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: security_policy_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Security Policy
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
    delete:
      tags:
        - Security Policy
      summary: Delete a Security Policy
      description: |-
        Deletes the specified Security Policy

        This endpoint requires the following role: `security_admin`.
      parameters:
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: security_policy_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Security Policy
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/resolve:
    post:
      tags:
        - Servers
      summary: Resolve Resource Names
      description: >-
        Resolves enrolled resource names and returns any associated information
        and user access methods (UAMs)
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                names:
                  - <string>
                  - <string>
                client_features:
                  - <string>
                  - <string>
                include_user_access_methods: <boolean>
                resource_type: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                results:
                  - name: api-server-west-01.example.com
                    servers:
                      - team_name: x-factor
                        id: 8370a376-7858-4fa3-93f2-1b0b0b0b0b0b
                        project_name: test_example_project
                        hostname: api-server-west-01.example.com
                        alt_names:
                          - api-server-west-01.example.com
                          - ip-10-1-1-1-internal
                        bastion: bastion-node1.example.com
                        canonical_name: api-server-west-01.example.com
                        access_address: 10.1.1.1
                        os: Debian 11.6
                        os_type: linux
                        services:
                          - ssh
                          - broker
                        registered_at: '2023-02-06T21:09:22.517764Z'
                        last_seen: '2023-08-14T03:23:52.582553Z'
                        sftd_version: 1.23.4
                        cloud_provider: aws
                        ssh_host_keys:
                          - ssh-rsa xxx
                        broker_host_certs:
                          - token
                        instance_details:
                          instance_id: i-00112233445566
                          account_id: '00112233445566'
                          availability_zone: us-west-2c
                          networks:
                            - mac: 00-00-00-00-00-00
                              vpc_id: vpc-0011223344
                              addresses:
                                - 10.0.0.1
                          public_ip_v4: ''
                          instance_type: m5.large
                        state: ACTIVE
                        managed: true
                        deleted_at: null
  /v1/teams/{team_name}/all_server_accounts:
    get:
      tags:
        - Servers
      summary: List all Server Account Resources
      description: |-
        Lists all Server Account Resources for the current Security Admin

        This endpoint requires the following role: `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
  /v1/teams/{team_name}/all_servers:
    get:
      tags:
        - Servers
      summary: List all Servers
      description: |-
        Lists all Servers for your Team

        This endpoint requires the following role: `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/all_server_accounts:
    get:
      tags:
        - Servers
      summary: List all Server Account Resources in a Resource group
      description: >-
        Lists all Server Account Resources for the current Security Admin or
        Delegated Security Admin for the Resource Group


        This endpoint requires one of the following roles: `security_admin`,
        `delegated_security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/servers:
    get:
      tags:
        - Servers
      summary: List all Servers in a Project
      description: >-
        Lists all Servers in a Project in a Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list: {}
  /v1/teams/{team_name}/resource_groups/{resource_group_id}/projects/{project_id}/servers/{server_id}:
    get:
      tags:
        - Servers
      summary: Retrieve a Server from a Project
      description: >-
        Retrieves a Server from a Project in a Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
        - name: server_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of an enrolled Server
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                team_name: j
                id: 2091ccbd-e04a-5c72-85ec-58be8ad37733
                project_name: sint eiusmod sed Excepteur dolor
                hostname: cupidatat proident
                alt_names:
                  - laborum eiusmod
                  - laboris deserunt sunt
                bastion: ut
                canonical_name: dolor nisi
                access_address: 'consequat in veniam '
                os: ipsum enim sunt veniam sed
                os_type: sint sunt quis proident Ut
                services:
                  - est ipsum proident irure
                  - amet
                registered_at: '2015-03-04T04:44:49.482Z'
                last_seen: '1946-08-23T16:38:34.390Z'
                sftd_version: labore tempor laboris incididunt exercitation
                ssh_host_keys:
                  - aliqua sit Lorem Duis
                  - in Lorem
                state: sint dolore
                managed: true
                deleted_at: '1977-07-21T17:48:32.038Z'
                labels:
                  fugiat_7e: voluptate Duis
                cloud_provider: gce
                instance_details:
                  instance_id: sunt eiusmod
                  account_id: proident sunt et ex
                  availability_zone: nulla sit minim
                  instance_type: ullamco laborum exercitation
                  networks:
                    - mac: deserunt Ut amet a
                      addresses:
                        - 'in ut sit adipisicing '
                        - proident sunt L
                      vpc_id: ut eu
                    - mac: pariatur sit
                      addresses:
                        - deserunt cillum proi
                        - in la
                      vpc_id: aliqua pr
                  public_ip_v4: nisi eu dolore enim
                  _type: mollit
    delete:
      tags:
        - Servers
      summary: Delete a Server from a Project
      description: >-
        Deletes a Server from a Project in a Resource Group


        This endpoint requires one of the following roles: `resource_admin`,
        `delegated_resource_admin`.
      parameters:
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: resource_group_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Resource Group
          example: <string>
        - name: project_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Project
          example: <string>
        - name: server_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of an enrolled Server
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/service_token:
    post:
      tags:
        - Service Users
      summary: Issue a Service User token
      description: >-
        Most calls to the OPA API require an HTTP `Authorization` header with a
        value of `Bearer ${AUTH_TOKEN}`.

        To retrieve an auth token, you need to create an API key for a Service
        User and pass the API key information to this endpoint.

        Auth tokens may expire at any time, so code that uses them should be
        prepared to handle a 401 response code by creating a new auth token.


        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                key_id: <regex>
                key_secret: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                bearer_token: >-
                  eyJhbGciOiJSUzI1NiIsImtpZCI6ImI4YTAzODA0MTM0NjctNGU5OC04ZDU2LTAxNDRlNGNkMGViMCIsInR5cCI6IkpXVCJ9eeyJleHAiOjE0NzY4MTE1OTAsImlzcyI6InNjYWxlZnQuYXV0aC50b2tlbiIsImp0aSI6IjA0YjRhNTE4LWU5YzYtNDc1My05YWY4LThlOTAwNjVjNjX5YSIsInJvbGVzIjp7IjE0NzY4MTE1OTAiOm51bGx9LCJ0ZWFtIjoic2NhbGVmdCIsInVzZXIiOiJyb2JvdF9ydXNzZWxsIn0.pHuv06Q1-sKjHrGXUzQi-uM7AAG3K1Q6RyukyuR2Py6QHwLot1uZmZt4wrBo6tQRCl3RjHBKGcDmEfBZ6_gFucksFMkINTU3sIDmOvSAChopraXjfYh0KarEDmDnIMsEPl7FVhl4N_I0yLK9O5XSS07AvAc-7RRD8dupe7inDITCHEvoJ16osgL1IzoDvc7ZPDj8-xhJ_kAsKc-vJ5WYESAlCFx_fixedM43Apg2TySNE5nSeJFCa02F4ViZleY7K2l4h_p143DzVZjWEBeKmyQVRXhbZzL6HwONOckham_LHuSrP_sOtVc7BrFwmZq2NZtXEOWyQWfJ4Yp0qg8NzV2LhKLc4LookQuilt8OA8jyEeTabu3Rq9zp0y-FodMg64qfWcPSu53HiwYC9dags5zhXa8zuZRcPMO_orCPVYnmO761xAfsp-P8aJJZDqpxlzKA0s-ClBegunC5C9Xq5snIq-f4hT45u8ldBfAr6dLkDO8BdPMTeutH52bTWX3iJ1ipW1YqMefJhPMzBHLwnJ3SYWN7WTEuRyoC6ndQ60PcEzsPJYAO5MxdY4WsnYOqv3aIryuTlwW3K0dNqcvBSirdar5X7AvidO-XLSXXrY134BogaLBze7FwVYwH7ZhzBdX-DwsUwQsJ7R0mRWxpNnhGu7NjkbB0-QJs
                expires_at: '2016-10-18T17:26:30Z'
                team_name: scaleft
  /v1/teams/{team_name}/service_users:
    get:
      tags:
        - Service Users
      summary: List all Service Users for a Team
      description: >-
        Lists all Service Users for your Team


        This endpoint requires one of the following roles: `pam_admin`,
        `security_admin`, `resource_admin`, `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: contains
          in: query
          schema:
            type: string
          description: Only return results that include the specified value
          example: <string>
        - name: count
          in: query
          schema:
            type: string
          description: The number of objects per page
          example: <integer>
        - name: descending
          in: query
          schema:
            type: string
          description: The object order
          example: <boolean>
        - name: id
          in: query
          schema:
            type: string
          description: Only return results with the specified IDs
          example: <string>
        - name: include_service_users
          in: query
          schema:
            type: string
          description: Only return Service Users in the results
          example: <string>
        - name: offset
          in: query
          schema:
            type: string
          description: >-
            The offset value for pagination. The **rel="next"** and
            **rel="prev"** `Link` headers define the offset for subsequent or
            previous pages.
          example: <string>
        - name: prev
          in: query
          schema:
            type: string
          description: The direction of paging
          example: <boolean>
        - name: starts_with
          in: query
          schema:
            type: string
          description: Only return Users with a name that begins with the specified value
          example: <string>
        - name: status
          in: query
          schema:
            type: string
          description: >-
            Only return Users with the specified status. Valid statuses:
            `ACTIVE`, `DISABLED`, and `DELETED`.
          example: <string>
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
                example: consectetur occaecat
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - team_name: william-faulkner
                    id: aa225c16-af6e-4ab4-9150-456fd472e2d7
                    name: OPA User
                    status: ACTIVE
                    details: null
                    user_type: service
                    deleted_at: null
                  - team_name: william-faulkner
                    id: 6b69de4e-90be-4016-9085-d54bf5815da1
                    name: A.User
                    status: DISABLED
                    details: null
                    user_type: service
                    deleted_at: null
    post:
      tags:
        - Service Users
      summary: Create a Service User
      description: >-
        Creates a Service User that can be used to automate interactions with
        the OPA API


        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                name: <regex>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                deleted_at: null
                details: null
                id: aa225c16-af6e-4ab4-9150-456fd472e2d7
                name: OPA User
                status: ACTIVE
                team_name: william-faulkner
                user_type: service
  /v1/teams/{team_name}/service_users/{user_name}:
    get:
      tags:
        - Service Users
      summary: Retrieve a Service User
      description: >-
        Retrieve a specified Service User


        This endpoint requires one of the following roles: `pam_admin`,
        `security_admin`, `resource_admin`, `delegated_resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: user_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The username for an existing User
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                deleted_at: null
                details: null
                id: 6b69de4e-90be-4016-9085-d54bf5815da1
                name: A.User
                status: ACTIVE
                team_name: william-faulkner
                user_type: service
    put:
      tags:
        - Service Users
      summary: Update a Service User
      description: |-
        Updates a specified Service User

        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                status: <string>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: user_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The username for an existing User
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                deleted_at: null
                details: null
                id: 6b69de4e-90be-4016-9085-d54bf5815da1
                name: A.User
                status: DISABLED
                team_name: william-faulkner
                user_type: service
  /v1/teams/{team_name}/service_users/{user_name}/keys:
    get:
      tags:
        - Service Users
      summary: List all API keys
      description: >-
        Lists all API keys for a specified Service User. This doesn't return the
        corresponding secret for each API key.


        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: user_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The username for an existing User
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
                example: consectetur occaecat
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - id: c6de9d40-1e6c-4033-88cb-992367d162eb
                    issued_at: '2020-04-07T02:00:00Z'
                    expires_at: '0001-01-01T00:00:00Z'
                    last_used: null
                  - id: f37fadfc-fa03-4f46-a390-ce202772cff4
                    issued_at: '2020-04-07T00:00:00Z'
                    expires_at: '2020-04-09T00:00:00Z'
                    last_used: null
    post:
      tags:
        - Service Users
      summary: Rotate all API keys
      description: >-
        Rotates all API keys for a specified Service User. This also sets an
        expiration date for the existing API keys.


        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content: {}
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: user_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The username for an existing User
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                expires_at: '0001-01-01T00:00:00Z'
                id: ba7ffbe9-c8e4-45c9-bc07-45729711c952
                issued_at: '2020-04-07T00:00:00Z'
                last_used: null
                secret: >-
                  NOvsvBg0g9mFXdHbLxEJcEFpu+LZjQSKsYezqMALq5WbGZTpUsxoS4vBqqHOO9O3xrhOq03B+oLf7bSTShbudw==
  /v1/teams/{team_name}/service_users/{user_name}/keys/{key_id}:
    delete:
      tags:
        - Service Users
      summary: Delete an API key
      description: >-
        Deletes an API key for a Service User. The Service User can no longer
        authenticate with this API key.


        This endpoint requires the following role: `resource_admin`.
      parameters:
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: user_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The username for an existing User
          example: <string>
        - name: key_id
          in: path
          schema:
            type: string
          required: true
          description: (Required) The UUID of a Service User key
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/roles:
    get:
      tags:
        - Teams
      summary: List all roles
      description: |-
        Lists all roles available to your Team

        This endpoint requires one of the following roles: `pam_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - name: pam_admin
                  - name: security_admin
                  - name: resource_admin
                  - name: end_user
  /v1/teams/{team_name}/servers:
    get:
      tags:
        - Teams
      summary: List all Servers for a Team
      description: >-
        Lists all Servers in your Team. This only returns Servers available to
        the requesting User.


        This endpoint requires the following role: `end_user`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: AdServers
          in: query
          schema:
            type: string
          description: >-
            If `true`, only return AD servers. If `false`, only return Non-AD
            servers
          example: <boolean>
        - name: alt_names_contains
          in: query
          schema:
            type: string
          description: Only return Servers that contain the specified alternate name
          example: <string>
        - name: bastion
          in: query
          schema:
            type: string
          description: Only return Servers associated with the specified bastion
          example: <string>
        - name: canonical_name
          in: query
          schema:
            type: string
          description: A canonical name
          example: <string>
        - name: cloud_account
          in: query
          schema:
            type: string
          description: Only return Servers associated with the specified cloud account
          example: <string>
        - name: cloud_provider
          in: query
          schema:
            type: string
          description: >-
            Only return Servers associated with the specified cloud provider.
            Possible values: `aws` or `gce`
          example: <string>
        - name: count
          in: query
          schema:
            type: string
          description: The number of objects per page
          example: <integer>
        - name: credentialed
          in: query
          schema:
            type: string
          description: >-
            If `true`, only return unmanaged Servers with credential issuance
            enabled. If `false`, only return unmanaged Servers with credential
            issuance disabled.
          example: <boolean>
        - name: descending
          in: query
          schema:
            type: string
          description: The object order
          example: <boolean>
        - name: has_account_under_management
          in: query
          schema:
            type: string
          description: >-
            If `true`, only return Servers that currently have at least one
            account's password under management'.  If `false`, only return
            servers that do not currently have an account whose password is
            under management.
          example: <boolean>
        - name: hostname
          in: query
          schema:
            type: string
          description: Only return Servers that contain the specified hostname
          example: <string>
        - name: id
          in: query
          schema:
            type: string
          description: >-
            Only return Servers with the specified IDs. Only usable for PAM
            administrative views of servers, not end-user Server views.
          example: <string>
        - name: instance_id
          in: query
          schema:
            type: string
          description: Only return Servers that contain the specified instance ID
          example: <string>
        - name: managed
          in: query
          schema:
            type: string
          description: >-
            If `true`, only return managed servers. If `false`, only return
            unmanaged servers.
          example: <boolean>
        - name: offset
          in: query
          schema:
            type: string
          description: >-
            The offset value for pagination. The **rel="next"** and
            **rel="prev"** `Link` headers define the offset for subsequent or
            previous pages.
          example: <string>
        - name: prev
          in: query
          schema:
            type: string
          description: The direction of paging
          example: <boolean>
        - name: project_name
          in: query
          schema:
            type: string
          description: Only return Servers that belong to the specified Project
          example: <string>
        - name: state
          in: query
          schema:
            type: string
          description: >-
            Include Servers with the specified state. Valid statuses: `ACTIVE`
            or `INACTIVE`.
          example: <string>
        - name: selector
          in: query
          schema:
            type: string
          description: Only return Servers that contain the specified Server selectors.
          example: <string>
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
                example: consectetur occaecat
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - team_name: william-faulkner
                    id: c80996c5-c496-47bf-9271-e463f4d30f11
                    hostname: harvard
                    alt_names: null
                    bastion: null
                    canonical_name: null
                    access_address: null
                    os: Ubuntu 16.04
                    os_type: linux
                    services:
                      - broker
                      - ssh
                    registered_at: '0001-01-01T00:00:00Z'
                    last_seen: '0001-01-01T00:00:00Z'
                    sftd_version: 1.44.4
                    cloud_provider: null
                    ssh_host_keys: null
                    broker_host_certs: null
                    instance_details: null
                    state: INACTIVE
                    managed: true
                    deleted_at: '0001-01-01T00:00:00Z'
                    instance_id: null
                  - team_name: william-faulkner
                    id: 03a808c0-57ed-4264-8e4c-92f3c10156db
                    hostname: jefferson
                    alt_names: null
                    bastion: null
                    canonical_name: null
                    access_address: null
                    os: Ubuntu 16.04
                    os_type: linux
                    services:
                      - broker
                      - ssh
                    registered_at: '0001-01-01T00:00:00Z'
                    last_seen: '0001-01-01T00:00:00Z'
                    sftd_version: 1.44.4
                    cloud_provider: null
                    ssh_host_keys: null
                    broker_host_certs: null
                    instance_details: null
                    state: INACTIVE
                    managed: true
                    deleted_at: '0001-01-01T00:00:00Z'
                    instance_id: null
  /v1/teams/{team_name}/settings:
    get:
      tags:
        - Teams
      summary: Retrieve settings for a Team
      description: >-
        Retrieves Team-level settings for your Team


        This endpoint requires one of the following roles: `end_user`,
        `resource_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                approve_device_without_interaction: false
                client_session_duration: 36000
                post_device_enrollment_url: null
                post_login_url: null
                post_logout_url: null
                reactivate_users_via_idp: false
                team: Your_OPA_Team
                user_provisioning_exact_username: null
                web_session_duration: 36000
    put:
      tags:
        - Teams
      summary: Update settings for a Team
      description: >-
        Updates Team-level settings for your Team. Partial updates are
        permitted. To disable a setting, set the value to `null`.


        This endpoint requires the following role: `resource_admin`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                approve_device_without_interaction: <boolean>
                client_session_duration: <integer>
                post_device_enrollment_url: <string>
                post_login_url: <string>
                post_logout_url: <string>
                reactivate_users_via_idp: <boolean>
                user_provisioning_exact_username: <boolean>
                web_session_duration: <integer>
      parameters:
        - name: Content-Type
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '204':
          description: No Content
          headers:
            Content-Type:
              schema:
                type: string
                example: text/plain
          content:
            text/plain:
              schema:
                type: string
              example: ''
  /v1/teams/{team_name}/team_stats:
    get:
      tags:
        - Teams
      summary: Retrieve statistics for a Team
      description: >-
        Retrieves statistics about your Team


        This endpoint requires one of the following roles: `resource_admin`,
        `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                num_clients: 0
                num_gateways: 0
                num_groups: 1
                num_human_users: 1
                num_projects: 2
                num_servers: 1
                num_service_users: 0
  /v1/teams/{team_name}/vault/jwks.json:
    get:
      tags:
        - Teams
      summary: Retrieve the Vault JWKS
      description: >-
        Retrieves the Vault JWKS. Data sent to the vault must be encrypted to
        this key.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                keys: {}
  /v1/teams/{team_name}/current_user:
    get:
      tags:
        - Users
      summary: Retrieve User details
      description: Retrieves details about the current User
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                id: 305b1bd8-b783-4351-a2b6-204248c9ea46
                name: Jason.Compson.IV
                team_name: william-faulkner
  /v1/teams/{team_name}/users:
    get:
      tags:
        - Users
      summary: List all Users for a Team
      description: >-
        Lists all Users for your Team


        This endpoint requires one of the following roles: `pam_admin`,
        `resource_admin`, `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: contains
          in: query
          schema:
            type: string
          description: Only return results that include the specified value
          example: <string>
        - name: count
          in: query
          schema:
            type: string
          description: The number of objects per page
          example: <integer>
        - name: descending
          in: query
          schema:
            type: string
          description: The object order
          example: <boolean>
        - name: id
          in: query
          schema:
            type: string
          description: Only return results with the specified IDs
          example: <string>
        - name: include_service_users
          in: query
          schema:
            type: string
          description: Only return Service Users in the results
          example: <string>
        - name: offset
          in: query
          schema:
            type: string
          description: >-
            The offset value for pagination. The **rel="next"** and
            **rel="prev"** `Link` headers define the offset for subsequent or
            previous pages.
          example: <string>
        - name: prev
          in: query
          schema:
            type: string
          description: The direction of paging
          example: <boolean>
        - name: starts_with
          in: query
          schema:
            type: string
          description: Only return Users with a name that begins with the specified value
          example: <string>
        - name: status
          in: query
          schema:
            type: string
          description: >-
            Only return Users with the specified status. Valid statuses:
            `ACTIVE`, `DISABLED`, and `DELETED`.
          example: <string>
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
                example: consectetur occaecat
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - team_name: william-faulkner
                    id: 305b1bd8-b783-4351-a2b6-204248c9ea46
                    name: Jason.Compson.IV
                    status: ACTIVE
                    details:
                      first_name: Jason
                      last_name: Compson
                      full_name: Jason Compson IV
                      email: jason.compson@example.com
                    user_type: human
                    deleted_at: null
                  - team_name: william-faulkner
                    id: c5cf4dfd-1726-45e3-a1c9-17598d59004d
                    name: Benjy.Compson
                    status: DISABLED
                    details:
                      first_name: Benjy
                      last_name: Compson
                      full_name: Benjy Compson
                      email: benjy.compson@example.com
                    user_type: human
                    deleted_at: null
                  - team_name: william-faulkner
                    id: 6f1b97c1-176a-4bfe-870a-754b6126b814
                    name: Quentin.Compson.III
                    status: DELETED
                    details:
                      first_name: Quentin
                      last_name: Compson
                      full_name: Quentin Compson III
                      email: quentin.compson@example.com
                    user_type: human
                    deleted_at: '1910-06-10T00:00:00Z'
  /v1/teams/{team_name}/users/{user_name}:
    get:
      tags:
        - Users
      summary: Retrieve a User
      description: >-
        Retrieves a User from your Team


        This endpoint requires one of the following roles: `pam_admin`,
        `resource_admin`, `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: user_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The username for an existing User
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                deleted_at: null
                details:
                  email: jason.compson@example.com
                  first_name: Jason
                  full_name: Jason Compson IV
                  last_name: Compson
                id: 305b1bd8-b783-4351-a2b6-204248c9ea46
                name: Jason.Compson.IV
                status: ACTIVE
                team_name: william-faulkner
                user_type: human
  /v1/teams/{team_name}/users/{user_name}/groups:
    get:
      tags:
        - Users
      summary: List all Groups for a User
      description: >-
        Lists all Groups for a specified User


        This endpoint requires one of the following roles: `pam_admin`,
        `resource_admin`, `security_admin`.
      parameters:
        - name: Accept
          in: header
          schema:
            type: string
          example: application/json
        - name: contains
          in: query
          schema:
            type: string
          description: Only return results that include the specified value
          example: <string>
        - name: count
          in: query
          schema:
            type: string
          description: The number of objects per page
          example: <integer>
        - name: descending
          in: query
          schema:
            type: string
          description: The object order
          example: <boolean>
        - name: id
          in: query
          schema:
            type: string
          description: Only return results with the specified IDs
          example: <string>
        - name: ignore
          in: query
          schema:
            type: string
          description: Ignore Groups with the specified names. This is case sensitive.
          example: <string>
        - name: include_deleted
          in: query
          schema:
            type: string
          description: If `true`, include deleted Groups in the results
          example: <boolean>
        - name: offset
          in: query
          schema:
            type: string
          description: >-
            The offset value for pagination. The **rel="next"** and
            **rel="prev"** `Link` headers define the offset for subsequent or
            previous pages.
          example: <string>
        - name: only_include_deleted
          in: query
          schema:
            type: string
          description: If `true`, only return deleted Groups in the results
          example: <boolean>
        - name: prev
          in: query
          schema:
            type: string
          description: The direction of paging
          example: <boolean>
        - name: team_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The name of your Team
          example: <string>
        - name: user_name
          in: path
          schema:
            type: string
          required: true
          description: (Required) The username for an existing User
          example: <string>
      responses:
        '200':
          description: OK
          headers:
            Link:
              schema:
                type: string
                example: consectetur occaecat
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                list:
                  - id: b5a346c5-bafa-40eb-bb9f-401c0f57db36
                    name: compsons
                    roles:
                      - pam_admin
                      - resource_admin
                    deleted_at: '0001-01-01T00:00:00Z'
