Firebolt Iam.v2.actors API

openapi: 3.2.0
info:
  title: Firebolt Iam.v2.actors API
  version: 1.0.0
  x-logo:
    altText: Firebolt
    backgroundColor: '#FFFFFF'
    url: https://assets.website-files.com/5e8a264ceaf4870394477fc7/5e8a264ceaf4879f75477fdd_logo_website.svg
tags:
- name: iam.v2.actors
  x-displayName: Actors
paths:
  /iam/v2/actors:getByResourceID:
    post:
      tags:
      - iam.v2.actors
      summary: Retrieves an actor by it's resource ID
      operationId: iamV2GetActorByResourceID
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firebolt.iam.v2.GetActorByResourceIDResponse'
        default:
          description: An unexpected error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/firebolt.iam.v2.GetActorByResourceIDRequest'
        required: true
  /iam/v2/actors:getMy:
    get:
      security: []
      tags:
      - iam.v2.actors
      summary: Returns current actor
      operationId: iamV2GetMyActor
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firebolt.iam.v2.GetMyActorResponse'
        default:
          description: An unexpected error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
components:
  schemas:
    firebolt.iam.v2.GetMyActorResponse:
      type: object
      properties:
        actor:
          description: Retrieved record.
          $ref: '#/components/schemas/firebolt.iam.v2.Actor'
    grpc.gateway.runtime.Error:
      type: object
      properties:
        code:
          type: integer
          format: int32
        details:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
        error:
          type: string
        message:
          type: string
    firebolt.iam.v2.ServiceAccount:
      description: 'A service account is a special type of user intended to represent a non-human user that needs to authenticate

        and be authorized to access data in Firebolt APIs.'
      type: object
      properties:
        client_id:
          description: Output only. ID that should be used in "client_credentials" flow.
          type: string
          readOnly: true
        client_secret:
          description: Output only. Secret key that should be used in "client_credentials" flow.
          type: string
          readOnly: true
        create_actor:
          description: Output only. Resource name of the actor who created this record.
          type: string
          readOnly: true
        create_time:
          description: Output only. Time when this record was created.
          type: string
          format: date-time
          readOnly: true
        description:
          description: Optional. User-friendly description about purpose of this service account.
          type: string
          maxLength: 4096
        display_name:
          description: Required. User-friendly name.
          type: string
          maxLength: 255
          minLength: 1
        id:
          description: Output only. Record ID.
          $ref: '#/components/schemas/firebolt.iam.v2.ServiceAccountID'
          readOnly: true
        last_update_actor:
          description: Output only. Resource name of the actor who last updated this record.
          type: string
          readOnly: true
        last_update_time:
          description: Output only. Time when this record was last updated.
          type: string
          format: date-time
          readOnly: true
    firebolt.iam.v2.GetActorByResourceIDRequest:
      type: object
      properties:
        resource_id:
          description: Required. ID of the resource.
          type: string
          minLength: 1
    firebolt.iam.v2.Actor:
      description: Actor represents ann authorization principal that can use Firebolt API.
      type: object
      properties:
        service_account:
          $ref: '#/components/schemas/firebolt.iam.v2.ServiceAccount'
        user:
          $ref: '#/components/schemas/firebolt.iam.v2.User'
    firebolt.iam.v2.UserStatus:
      description: "UserStatus represents an activity status of the user.\n\n - USER_STATUS_ACTIVE: User is allowed to authenticate.\n - USER_STATUS_BLOCKED: User is not allowed to authenticate.\n - USER_STATUS_DELETED: User is removed. No further activities are allowed."
      type: string
      default: USER_STATUS_UNSPECIFIED
      enum:
      - USER_STATUS_UNSPECIFIED
      - USER_STATUS_ACTIVE
      - USER_STATUS_BLOCKED
      - USER_STATUS_DELETED
    google.protobuf.Any:
      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 := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, 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    }"
      type: object
      properties:
        type_url:
          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."
          type: string
        value:
          description: Must be a valid serialized protocol buffer of the above specified type.
          type: string
          format: byte
    firebolt.iam.v2.User:
      description: User represents an individual user that can authenticate to Firebolt.
      type: object
      properties:
        auth0_id:
          description: Output only. ID of the user in Auth0.
          type: string
          readOnly: true
        company_name:
          description: Optional. Name of the company this user works for.
          type: string
          maxLength: 255
        create_time:
          description: Output only. Time when this record was created.
          type: string
          format: date-time
          readOnly: true
        display_name:
          description: Optional. Short name of the person.
          type: string
          maxLength: 64
        email:
          description: Email address. Will be used as a login credential for userCreate. Not used in userUpdate.
          type: string
        first_name:
          description: Required. First name of the person.
          type: string
          maxLength: 64
          minLength: 1
        id:
          description: Output only. Unique record ID.
          type: string
          readOnly: true
        iid:
          description: 'Output only. Record ID (integer).


            Note. This field will be removed when we will finish migration to the new APIs.

            Use `id` instead if possible.'
          type: string
          format: uint64
          readOnly: true
        ip_allow_list:
          description: Optional. IP allow list (Auth0).
          type: array
          items:
            type: string
        ip_deny_list:
          description: Optional. IP deny list (Auth0).
          type: array
          items:
            type: string
        job_title:
          description: Optional. Job position title.
          type: string
          maxLength: 255
        last_name:
          description: Required. Last name of the person.
          type: string
          maxLength: 64
          minLength: 1
        last_update_time:
          description: Output only. Time when this record was last updated.
          type: string
          format: date-time
          readOnly: true
        mfa_enabled:
          description: Output only. Is MFA enabled for this user (Auth0).
          type: boolean
          format: boolean
          readOnly: true
        password:
          description: Required. Input Only. Password.
          type: string
          maxLength: 64
          minLength: 6
        phone_number:
          description: Optional. Contact phone number.
          type: string
          maxLength: 64
        status:
          description: Output only. Current user status.
          $ref: '#/components/schemas/firebolt.iam.v2.UserStatus'
          readOnly: true
    firebolt.iam.v2.ServiceAccountID:
      description: ServiceAccountID represents unique identifier of the record.
      type: object
      properties:
        account_id:
          description: 'Required. ID of the account this record belongs to.

            Empty value means "system".'
          type: string
        service_account_id:
          description: Required. Unique record ID.
          type: string
    firebolt.iam.v2.GetActorByResourceIDResponse:
      type: object
      properties:
        actor:
          $ref: '#/components/schemas/firebolt.iam.v2.Actor'
x-tagGroups:
- name: Getting Started
  tags:
  - auth.v1
- name: Identity & Access Management
  tags:
  - iam.v2.roles
  - iam.v2.permissions
  - iam.v2.policies
  - iam.v2.databaseGrants
  - iam.v2.accounts
  - iam.v2.users
  - iam.v2.accountMembers
  - iam.v2.serviceAccounts
  - iam.v2.actors
- name: Cloud Providers
  tags:
  - aws.v2.marketplace
- name: Compute Resources
  tags:
  - compute.v1.instanceTypes
  - compute.v1.regions
  - compute.v1.providers
- name: Databases & Engines
  tags:
  - core.v1.databases
  - core.v1.engines
  - core.v1.engineRevisions
  - core.v1.bindings
- name: SQL Editor
  tags:
  - editor.v1.scripts
x-provenance:
  method: harvested
  publisher: Firebolt
  source: https://api.app.firebolt.io/docs/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)