DataRobot Meta Memory Space API

openapi: 3.2.0
info:
  contact:
    email: support@datarobot.com
    name: DataRobot Support
    url: https://support.datarobot.com
  description: DataRobot's Public facing API
  license:
    name: DataRobot Tool and Utility Agreement
    url: https://www.datarobot.com/wp-content/uploads/2021/07/DataRobot-Tool-and-Utility-Agreement.pdf
  title: Public Meta Memory Space API
  version: 2.49.0
  x-datarobot-release-version: Latest
servers:
- url: https://app.datarobot.com/
security:
- BearerAuth: []
tags:
- description: Use the endpoints described below to manage meta memory spaces, which represent Memory Spaces for role-based access control (RBAC) purposes.
  name: meta_memory_space
paths:
  /api/v2/metaMemorySpaces/{metaMemorySpaceId}/sharedRoles/:
    get:
      description: Get a list of users, groups, and organizations with access to this meta memory space.
      operationId: metaMemorySpacesSharedRoles_list
      parameters:
      - description: Only return roles for a user, group or organization with this identifier.
        in: query
        name: id
        required: false
        schema:
          type: string
      - description: This many results will be skipped
        in: query
        name: offset
        required: true
        schema:
          default: 0
          minimum: 0
          type: integer
      - description: At most this many results are returned
        in: query
        name: limit
        required: true
        schema:
          default: 10
          maximum: 100
          minimum: 1
          type: integer
      - description: Only return roles for a user, group or organization with this name.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: The list of access controls for recipients with this type.
        in: query
        name: shareRecipientType
        required: false
        schema:
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      - description: The ID of the meta memory space.
        in: path
        name: metaMemorySpaceId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharingListV2Response'
          description: ''
      summary: Get a list of users, groups, and organizations with access by meta memory space…
      tags:
      - meta_memory_space
      x-versionadded: v2.47
    patch:
      description: Share a meta memory space with a user, group, or organization.
      operationId: metaMemorySpacesSharedRoles_patchMany
      parameters:
      - description: The ID of the meta memory space.
        in: path
        name: metaMemorySpaceId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetaMemorySpaceSharingUpdateOrRemove'
      responses:
        '204':
          description: The roles were updated successfully.
        '422':
          description: The request was formatted improperly.
      summary: Share a meta memory space by meta memory space ID
      tags:
      - meta_memory_space
      x-versionadded: v2.47
components:
  schemas:
    SharingRole:
      description: 'External sharing roles representing the permission level a user, group or

        organization holds on an entity.


        These roles map to internal permissions and are used in sharing APIs.'
      enum:
      - NO_ROLE
      - OWNER
      - READ_WRITE
      - EDITOR
      - USER
      - DATA_SCIENTIST
      - ADMIN
      - READ_ONLY
      - CONSUMER
      - OBSERVER
      title: SharingRole
      type: string
    SubjectType:
      description: Enum of possible subject types.
      enum:
      - user
      - group
      - organization
      - role
      - externalApplication
      title: SubjectType
      type: string
    GrantAccessControlWithUsername:
      description: Grant access control request using username for user identification.
      properties:
        role:
          $ref: '#/components/schemas/SharingRole'
          description: The role of the recipient on this entity.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - NO_ROLE
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type: string
        shareRecipientType:
          $ref: '#/components/schemas/SubjectType'
          description: Describes the recipient type — one of user, group, organization, or externalApplication.
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
        username:
          description: Username of the user to update the access role for.
          title: Username
          type: string
      required:
      - role
      - shareRecipientType
      - username
      title: GrantAccessControlWithUsername
      type: object
    AccessControlV2:
      properties:
        id:
          description: The identifier of the recipient.
          type: string
        name:
          description: The name of the recipient.
          type: string
        role:
          description: The role of the recipient on this entity.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type: string
        scimIdpName:
          description: The SCIM identity provider name. Applicable to user and group recipients.
          type:
          - string
          - 'null'
          x-versionadded: v2.46
        scimManaged:
          description: Whether the recipient is SCIM-managed. Applicable to user and group recipients.
          type: boolean
          x-versionadded: v2.46
        shareRecipientType:
          description: The type of the recipient.
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      required:
      - id
      - name
      - role
      - shareRecipientType
      type: object
    GrantAccessControlWithId:
      description: 'Grant access control request using ID for recipient identification.


        Can be used for users, groups, organizations, or external applications.'
      properties:
        id:
          description: The ID of the recipient.
          title: Id
          type: string
        role:
          $ref: '#/components/schemas/SharingRole'
          description: The role of the recipient on this entity.
          enum:
          - ADMIN
          - CONSUMER
          - DATA_SCIENTIST
          - EDITOR
          - NO_ROLE
          - OBSERVER
          - OWNER
          - READ_ONLY
          - READ_WRITE
          - USER
          type: string
        shareRecipientType:
          $ref: '#/components/schemas/SubjectType'
          description: Describes the recipient type — one of user, group, organization, or externalApplication.
          enum:
          - user
          - group
          - organization
          - externalApplication
          type: string
      required:
      - id
      - role
      - shareRecipientType
      title: GrantAccessControlWithId
      type: object
    SharingListV2Response:
      properties:
        count:
          description: The number of items returned.
          type: integer
        data:
          description: The access control list.
          items:
            $ref: '#/components/schemas/AccessControlV2'
          maxItems: 1000
          type: array
        next:
          description: The URL pointing to the next page.
          type:
          - string
          - 'null'
        previous:
          description: The URL pointing to the previous page.
          type:
          - string
          - 'null'
        totalCount:
          description: The total number of items matching the condition.
          type: integer
      required:
      - count
      - data
      - next
      - previous
      - totalCount
      type: object
    MetaMemorySpaceSharingUpdateOrRemove:
      properties:
        note:
          default: ''
          description: A note to go with the project share
          maxLength: 512
          type: string
        operation:
          description: Name of the action being taken. The only operation is 'updateRoles'.
          enum:
          - updateRoles
          type: string
        roles:
          description: Array of GrantAccessControl objects., up to maximum 100 objects.
          items:
            oneOf:
            - $ref: '#/components/schemas/GrantAccessControlWithUsername'
            - $ref: '#/components/schemas/GrantAccessControlWithId'
          maxItems: 100
          minItems: 1
          type: array
        sendNotification:
          default: false
          description: Send a notification?
          type: boolean
      required:
      - operation
      - roles
      type: object
      x-versionadded: v2.47
  securitySchemes:
    BearerAuth:
      description: JWT Bearer Auth
      scheme: bearer
      type: http