Fireblocks User groups (Beta) API

openapi: 3.2.0
info:
  title: Fireblocks User groups (Beta) API
  description: 'Fireblocks provides a suite of applications to manage digital asset operations and a complete development platform to build your business on the blockchain.


    - Visit our website for more information: Fireblocks Website

    - Visit our developer docs: Fireblocks DevPortal'
  version: 1.6.2
  contact:
    email: developers@fireblocks.com
servers:
- url: https://api.fireblocks.io/v1
  description: Fireblocks Production Environment Base URL
- url: https://sandbox-api.fireblocks.io/v1
  description: Fireblocks Sandbox Environment Base URL
tags:
- name: User groups (Beta)
paths:
  /management/user_groups:
    get:
      operationId: getUserGroups
      summary: List user groups
      description: 'Get all user groups in your workspace


        - Please note that this endpoint is available only for API keys with Admin/Non Signing Admin permissions.

        Endpoint Permission: Admin, Non-Signing Admin.'
      tags:
      - User groups (Beta)
      x-rate-limit-category: query
      responses:
        '200':
          description: List of the user groups in your workspace
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupsResponse'
        default:
          $ref: '#/components/responses/Error'
      x-readme:
        code-samples:
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<UserGroupsResponse>> = fireblocks.userGroupsBeta.getUserGroups();'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<List<UserGroupResponse>>> response = fireblocks.userGroupsBeta().getUserGroups();
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.user_groups_beta.get_user_groups();
          name: Fireblocks SDK Python example
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<UserGroupsResponse>> = fireblocks.userGroupsBeta.getUserGroups();'
      - lang: Java
        source: CompletableFuture<ApiResponse<List<UserGroupResponse>>> response = fireblocks.userGroupsBeta().getUserGroups();
      - lang: Python
        source: response = fireblocks.user_groups_beta.get_user_groups();
    post:
      operationId: createUserGroup
      summary: Create user group
      description: 'Create a new user group. Users with the Viewer role cannot be added to groups.

        Endpoint Permission: Admin, Non-Signing Admin.'
      tags:
      - User groups (Beta)
      x-rate-limit-category: write
      parameters:
      - $ref: '#/components/parameters/X-Idempotency-Key'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroupCreateRequest'
      responses:
        '201':
          description: User group created and pending approval
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUserGroupResponse'
        default:
          $ref: '#/components/responses/Error'
      x-readme:
        code-samples:
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<CreateUserGroupResponse>> = fireblocks.userGroupsBeta.createUserGroup(userGroupsBetaApiCreateUserGroupRequest);'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<CreateUserGroupResponse>> response = fireblocks.userGroupsBeta().createUserGroup(userGroupCreateRequest, idempotencyKey);
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.user_groups_beta.create_user_group(user_group_create_request, idempotency_key);
          name: Fireblocks SDK Python example
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<CreateUserGroupResponse>> = fireblocks.userGroupsBeta.createUserGroup(userGroupsBetaApiCreateUserGroupRequest);'
      - lang: Java
        source: CompletableFuture<ApiResponse<CreateUserGroupResponse>> response = fireblocks.userGroupsBeta().createUserGroup(userGroupCreateRequest, idempotencyKey);
      - lang: Python
        source: response = fireblocks.user_groups_beta.create_user_group(user_group_create_request, idempotency_key);
  /management/user_groups/{groupId}:
    get:
      operationId: getUserGroup
      summary: Get user group
      x-rate-limit-category: read
      description: 'Get a user group by ID.


        **Note**:

        - This endpoint is now in Beta, disabled for general availability at this time.

        - Please note that this endpoint is available only for API keys with Admin permissions.'
      tags:
      - User groups (Beta)
      parameters:
      - in: path
        required: true
        name: groupId
        description: The ID of the user group
        schema:
          type: string
      responses:
        '200':
          description: User group
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupResponse'
        default:
          $ref: '#/components/responses/Error'
      x-readme:
        code-samples:
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<UserGroupResponse>> = fireblocks.userGroupsBeta.getUserGroup(userGroupsBetaApiGetUserGroupRequest);'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<UserGroupResponse>> response = fireblocks.userGroupsBeta().getUserGroup(groupId);
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.user_groups_beta.get_user_group(group_id);
          name: Fireblocks SDK Python example
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<UserGroupResponse>> = fireblocks.userGroupsBeta.getUserGroup(userGroupsBetaApiGetUserGroupRequest);'
      - lang: Java
        source: CompletableFuture<ApiResponse<UserGroupResponse>> response = fireblocks.userGroupsBeta().getUserGroup(groupId);
      - lang: Python
        source: response = fireblocks.user_groups_beta.get_user_group(group_id);
    put:
      operationId: updateUserGroup
      summary: Update user group
      x-rate-limit-category: write
      description: 'Update a user group by ID.


        **Note**:

        - This endpoint is now in Beta, disabled for general availability at this time.

        - Please note that this endpoint is available only for API keys with Admin permissions.'
      tags:
      - User groups (Beta)
      parameters:
      - in: path
        required: true
        name: groupId
        description: The ID of the user group
        schema:
          type: string
      - $ref: '#/components/parameters/X-Idempotency-Key'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserGroupUpdateRequest'
      responses:
        '200':
          description: User group updated and the changes are pending approval
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupCreateResponse'
        default:
          $ref: '#/components/responses/Error'
      x-readme:
        code-samples:
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<UserGroupCreateResponse>> = fireblocks.userGroupsBeta.updateUserGroup(userGroupsBetaApiUpdateUserGroupRequest);'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<UserGroupCreateResponse>> response = fireblocks.userGroupsBeta().updateUserGroup(userGroupUpdateRequest, groupId, idempotencyKey);
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.user_groups_beta.update_user_group(user_group_update_request, group_id, idempotency_key);
          name: Fireblocks SDK Python example
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<UserGroupCreateResponse>> = fireblocks.userGroupsBeta.updateUserGroup(userGroupsBetaApiUpdateUserGroupRequest);'
      - lang: Java
        source: CompletableFuture<ApiResponse<UserGroupCreateResponse>> response = fireblocks.userGroupsBeta().updateUserGroup(userGroupUpdateRequest, groupId, idempotencyKey);
      - lang: Python
        source: response = fireblocks.user_groups_beta.update_user_group(user_group_update_request, group_id, idempotency_key);
    delete:
      operationId: deleteUserGroup
      summary: Delete user group
      description: 'Delete a user group by ID.


        **Note**:

        - This endpoint is now in Beta, disabled for general availability at this time.

        - Please note that this endpoint is available only for API keys with Admin permissions.'
      tags:
      - User groups (Beta)
      x-rate-limit-category: write
      parameters:
      - in: path
        required: true
        name: groupId
        description: The ID of the user group
        schema:
          type: string
      responses:
        '204':
          description: Request to delete user group submitted for approval
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        default:
          $ref: '#/components/responses/Error'
      x-readme:
        code-samples:
        - language: typescript
          code: 'const response: Promise<FireblocksResponse<void>> = fireblocks.userGroupsBeta.deleteUserGroup(userGroupsBetaApiDeleteUserGroupRequest);'
          name: Fireblocks SDK TypeScript example
        - language: java
          code: CompletableFuture<ApiResponse<Void>> response = fireblocks.userGroupsBeta().deleteUserGroup(groupId);
          name: Fireblocks SDK Java example
        - language: python
          code: response = fireblocks.user_groups_beta.delete_user_group(group_id);
          name: Fireblocks SDK Python example
      x-codeSamples:
      - lang: TypeScript
        source: 'const response: Promise<FireblocksResponse<void>> = fireblocks.userGroupsBeta.deleteUserGroup(userGroupsBetaApiDeleteUserGroupRequest);'
      - lang: Java
        source: CompletableFuture<ApiResponse<Void>> response = fireblocks.userGroupsBeta().deleteUserGroup(groupId);
      - lang: Python
        source: response = fireblocks.user_groups_beta.delete_user_group(group_id);
components:
  responses:
    Error:
      description: Error Response
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorSchema'
  parameters:
    X-Idempotency-Key:
      name: Idempotency-Key
      in: header
      description: A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.
      required: false
      schema:
        type: string
  schemas:
    UserGroupResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        status:
          type: string
        memberIds:
          type: array
          items:
            type: string
    UserGroupUpdateRequest:
      type: object
      properties:
        groupName:
          type: string
        memberIds:
          type: array
          items:
            type: string
    UserGroupCreateResponse:
      type: object
      properties:
        name:
          type: string
        id:
          type: string
        memberIds:
          type: array
          items:
            type: string
        status:
          type: string
    ErrorSchema:
      type: object
      properties:
        message:
          type: string
        code:
          type: number
    UserGroupCreateRequest:
      type: object
      properties:
        groupName:
          type: string
        memberIds:
          type: array
          items:
            type: string
    CreateUserGroupResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        memberIds:
          type: array
          items:
            type: string
        status:
          type: string
    UserGroupsResponse:
      type: array
      items:
        $ref: '#/components/schemas/UserGroupResponse'
  headers:
    X-Request-ID:
      schema:
        type: string
      description: Unique ID correlated to the API request. Please provide it in any support ticket you create or on Github issues related to Fireblocks SDKs
  securitySchemes:
    bearerTokenAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
x-readme:
  explorer-enabled: false
  samples-languages:
  - curl
  - javascript
  - python
x-provenance:
  method: harvested
  publisher: Fireblocks
  source: https://swagger.fireblocks.com/openapi.yaml
  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)