Chef Software users API

openapi: 3.2.0
info:
  title: external/applications/applications.proto ApplicationsService Users API
  version: version not set
servers:
- url: https://automate.chef.io/api/v0
tags:
- name: users
paths:
  /apis/iam/v2/self/{id}:
    put:
      summary: Update self (as user)
      description: 'Updates a local user''s own name or password.

        If changing the password, both "password" and "previous_password" are required.


        Authorization Action:

        ```

        iam:usersSelf:update

        ```'
      operationId: Users_UpdateSelf
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.iam.v2.UpdateSelfResp'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      parameters:
      - name: id
        description: ID of the user. Cannot be changed. Used to sign in.
        in: path
        required: true
        schema:
          type: string
      tags:
      - users
      x-code-samples:
      - lang: JSON
        source: '{"name": "My New Name", "password": "aNewSafePassword", "previous_password": "aPreviousSafePassword"}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chef.automate.api.iam.v2.UpdateSelfReq'
        required: true
  /apis/iam/v2/users:
    get:
      summary: List all users
      description: 'Lists all local users.


        Authorization Action:

        ```

        iam:users:list

        ```'
      operationId: Users_ListUsers
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.iam.v2.ListUsersResp'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      tags:
      - users
    post:
      summary: Create a user
      description: 'Creates a local user that can sign in to Automate and be a member of IAM teams

        and IAM policies.


        Authorization Action:

        ```

        iam:users:create

        ```'
      operationId: Users_CreateUser
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.iam.v2.CreateUserResp'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      tags:
      - users
      x-code-samples:
      - lang: JSON
        source: '{"name": "Display Name", "id": "username001rulez", "password": "aSafePassword"}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chef.automate.api.iam.v2.CreateUserReq'
        required: true
  /apis/iam/v2/users/{id}:
    get:
      summary: Get a user
      description: 'Returns the details for a local user.


        Authorization Action:

        ```

        iam:users:get

        ```'
      operationId: Users_GetUser
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.iam.v2.GetUserResp'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      parameters:
      - name: id
        description: ID of the user.
        in: path
        required: true
        schema:
          type: string
      tags:
      - users
    delete:
      summary: Delete a user
      description: 'Deletes a local user.


        Authorization Action:

        ```

        iam:users:delete

        ```'
      operationId: Users_DeleteUser
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.iam.v2.DeleteUserResp'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      parameters:
      - name: id
        description: ID of the user.
        in: path
        required: true
        schema:
          type: string
      tags:
      - users
    put:
      summary: Update a user
      description: 'Updates a local user''s name or password.


        Authorization Action:

        ```

        iam:users:update

        ```'
      operationId: Users_UpdateUser
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.iam.v2.UpdateUserResp'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      parameters:
      - name: id
        description: ID of the user. Cannot be changed. Used to sign in.
        in: path
        required: true
        schema:
          type: string
      tags:
      - users
      x-code-samples:
      - lang: JSON
        source: '{"name": "New Name", "password": "aSafePassword"}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chef.automate.api.iam.v2.UpdateUserReq'
        required: true
components:
  schemas:
    chef.automate.api.iam.v2.UpdateUserResp:
      type: object
      properties:
        user:
          $ref: '#/components/schemas/chef.automate.api.iam.v2.User'
    chef.automate.api.iam.v2.User:
      type: object
      properties:
        name:
          type: string
          description: Display name for local user.
        id:
          type: string
          description: Unique ID. Cannot be changed. Used to log in.
        membership_id:
          type: string
          description: Unique ID used to add local users to local teams. Cannot be changed.
    chef.automate.api.iam.v2.GetUserResp:
      type: object
      properties:
        user:
          $ref: '#/components/schemas/chef.automate.api.iam.v2.User'
    chef.automate.api.iam.v2.CreateUserResp:
      type: object
      properties:
        user:
          $ref: '#/components/schemas/chef.automate.api.iam.v2.User'
    chef.automate.api.iam.v2.ListUsersResp:
      type: object
      properties:
        users:
          type: array
          items:
            $ref: '#/components/schemas/chef.automate.api.iam.v2.User'
    google.protobuf.Any:
      type: object
      properties:
        type_url:
          type: string
          description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
        value:
          type: string
          format: byte
          description: Must be a valid serialized protocol buffer of the above specified type.
      description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := anypb.New(foo)\n     if err != nil {\n       ...\n     }\n     ...\n     foo := &pb.Foo{}\n     if err := any.UnmarshalTo(foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"
    chef.automate.api.iam.v2.UpdateUserReq:
      type: object
      example:
        name: New Name
        password: aSafePassword
      properties:
        id:
          type: string
          description: ID of the user. Cannot be changed. Used to sign in.
        name:
          type: string
          description: Display name for local user.
        password:
          type: string
          description: Password used to log in. Will overwrite preexisting password.
      required:
      - name
    chef.automate.api.iam.v2.UpdateSelfReq:
      type: object
      example:
        name: My New Name
        password: aNewSafePassword
        previous_password: aPreviousSafePassword
      properties:
        id:
          type: string
          description: ID of the user. Cannot be changed. Used to sign in.
        name:
          type: string
          description: Display name for local user.
        password:
          type: string
          description: 'New password for user. Used to sign in.

            Optional, but if included, previous_password is also required.'
        previous_password:
          type: string
          description: 'Previous password for user.

            Optional, but if included, password is also required.'
      required:
      - name
    grpc.gateway.runtime.Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
    chef.automate.api.iam.v2.CreateUserReq:
      type: object
      example:
        name: Display Name
        id: username001rulez
        password: aSafePassword
      properties:
        id:
          type: string
          description: Unique ID. Cannot be changed. Used to sign in.
        name:
          type: string
          description: Display name for local user.
        password:
          type: string
          description: Password for user. Used to sign in.
      required:
      - id
      - name
      - password
    chef.automate.api.iam.v2.UpdateSelfResp:
      type: object
      properties:
        user:
          $ref: '#/components/schemas/chef.automate.api.iam.v2.User'
    chef.automate.api.iam.v2.DeleteUserResp:
      type: object