openapi: 3.2.0
info:
  title: Gr4vy Roles API
  version: '1.0'
  description: 'Operations tagged Roles across 2 of this provider''s published API definitions: gr4vy-docs-v1-openapi.json, gr4vy-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sandbox.{id}.gr4vy.app
  x-speakeasy-server-id: sandbox
  variables:
    id:
      default: example
      description: The subdomain for your Gr4vy instance.
- url: https://api.{id}.gr4vy.app
  x-speakeasy-server-id: production
  variables:
    id:
      default: example
      description: The subdomain for your Gr4vy instance.
tags:
- name: Roles
  description: 'In Gr4vy, users can be granted access to specific types of resources and permissions

    to perform certain actions by being assigned one or more roles.'
paths:
  /roles:
    get:
      operationId: list-roles
      summary: List roles
      description: Returns a list of roles.
      tags:
      - Roles
      parameters:
      - schema:
          type: integer
          default: 20
          example: 1
          minimum: 1
          maximum: 100
          format: int32
        in: query
        name: limit
        description: Defines the maximum number of items to return for this request.
      - schema:
          type: string
          format: ''
          example: ZXhhbXBsZTE
        in: query
        name: cursor
        description: 'A cursor that identifies the page of results to return. This is used to

          paginate the results of this API.


          For the first page of results, this parameter can be left out.

          For additional pages, use the value returned by the API in

          the `next_cursor` field. Similarly the `previous_cursor` can be used to

          reverse backwards in the list.'
      responses:
        '200':
          description: Returns a list of roles.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Roles'
        '401':
          description: Returns an error if no valid authentication was provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401Unauthorized'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.sandbox.{id}.gr4vy.app
      x-speakeasy-server-id: sandbox
      variables:
        id:
          default: example
          description: The subdomain for your Gr4vy instance.
    - url: https://api.{id}.gr4vy.app
      x-speakeasy-server-id: production
      variables:
        id:
          default: example
          description: The subdomain for your Gr4vy instance.
  /roles/assignments:
    get:
      operationId: list-role-assignments
      summary: List role assignments
      description: 'Returns a list of role assignments.


        Role assignments can be filtered for a given role by providing

        the `role_id` search parameter, or for a given assignee by providing

        both the `assignee_type` and `assignee_id` parameters.'
      tags:
      - Roles
      parameters:
      - schema:
          type: string
          example: be828248-56de-481e-a580-44b6e1d4df81
          format: uuid
        in: query
        name: role_id
        description: Filters for role assignments for the role that has a matching `id` value.
      - schema:
          type: string
          example: user
          enum:
          - user
        in: query
        name: assignee_type
        description: Filters for role assignments for the assignee of the given type.
      - schema:
          type: string
          example: be828248-56de-481e-a580-44b6e1d4df81
          format: uuid
        in: query
        name: assignee_id
        description: 'Filters for role assignments for the assignee that has a matching `id` value.

          The `assignee_type` must also be specified.'
      - schema:
          type: integer
          default: 20
          example: 1
          minimum: 1
          maximum: 100
          format: int32
        in: query
        name: limit
        description: Defines the maximum number of items to return for this request.
      - schema:
          type: string
          format: ''
          example: ZXhhbXBsZTE
        in: query
        name: cursor
        description: 'A cursor that identifies the page of results to return. This is used to

          paginate the results of this API.


          For the first page of results, this parameter can be left out.

          For additional pages, use the value returned by the API in

          the `next_cursor` field. Similarly the `previous_cursor` can be used to

          reverse backwards in the list.'
      responses:
        '200':
          description: Returns a list of role assignments.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignments'
        '401':
          description: Returns an error if no valid authentication was provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401Unauthorized'
      security:
      - bearerAuth: []
    post:
      operationId: new-role-assignment
      summary: New role assignment
      description: Adds a role assignment, in effect applying a role to the given assignee.
      tags:
      - Roles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleAssignmentRequest'
      responses:
        '201':
          description: Returns the role assignment that was added.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleAssignment'
        '400':
          description: Returns an error if the request was badly formatted or missing required fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400BadRequest'
        '401':
          description: Returns an error if no valid authentication was provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401Unauthorized'
        '409':
          description: Returns an error if duplicate resource has been found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409DuplicateRecord'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.sandbox.{id}.gr4vy.app
      x-speakeasy-server-id: sandbox
      variables:
        id:
          default: example
          description: The subdomain for your Gr4vy instance.
    - url: https://api.{id}.gr4vy.app
      x-speakeasy-server-id: production
      variables:
        id:
          default: example
          description: The subdomain for your Gr4vy instance.
  /roles/assignments/{role_assignment_id}:
    parameters:
    - schema:
        type: string
        format: uuid
        example: 1cdac457-400f-4866-8da6-5c193a8db158
      name: role_assignment_id
      in: path
      required: true
      description: The unique ID for the role assignment.
    delete:
      operationId: delete-role-assignment
      summary: Delete role assignment
      description: 'Deletes a role assignment. The associated assignee will no longer be

        assigned the role.'
      tags:
      - Roles
      responses:
        '204':
          description: Returns an empty response.
        '401':
          description: Returns an error if no valid authentication was provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401Unauthorized'
        '404':
          description: Returns an error if the resource can not be found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404NotFound'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.sandbox.{id}.gr4vy.app
      x-speakeasy-server-id: sandbox
      variables:
        id:
          default: example
          description: The subdomain for your Gr4vy instance.
    - url: https://api.{id}.gr4vy.app
      x-speakeasy-server-id: production
      variables:
        id:
          default: example
          description: The subdomain for your Gr4vy instance.
components:
  schemas:
    RoleAssignmentRequest:
      title: Role Assignment (Create)
      description: A request to create a role assignment.
      type: object
      x-tags:
      - Roles
      required:
      - role
      - assignee
      properties:
        role:
          type: object
          description: The role to associate with the role assignment.
          required:
          - id
          properties:
            id:
              type: string
              format: uuid
              description: The ID of the role to associate with the role assignment.
              example: 462ab2e2-3e29-44bd-b39f-e4d1293affbb
        assignee:
          type: object
          description: The assignee to associate with the role assignment.
          required:
          - type
          - id
          properties:
            type:
              type: string
              description: The type of the assignee to associate with the role assignment.
              example: user
              enum:
              - user
            id:
              type: string
              format: uuid
              description: The ID of the assignee to associate with the role assignment.
              example: 42aae896-8ce2-4a60-b80a-5f6ae1dfbbd4
    RolePermissions:
      type: object
      title: Role permissions
      description: The permissions associated with a role.
      x-tags:
      - Roles
      properties:
        allow:
          type: array
          description: The list of permissions to allow for a role.
          items:
            type: string
          example:
          - buyers.read
          - payment-methods.read
          - transactions.read
    Error404NotFound:
      title: Not Found Error
      type: object
      description: Not Found Error (HTTP 404).
      x-tags:
      - Errors
      properties:
        type:
          type: string
          description: '`error`.'
          enum:
          - error
          example: error
        code:
          type: string
          description: The reason code for the error.
          example: not_found
          enum:
          - not_found
          - pending_creation
        status:
          type: integer
          description: '`404`.'
          example: 404
          enum:
          - 404
        message:
          type: string
          description: The human readable reason for the error.
          example: The resource could not be found
        details:
          type: array
          description: 'A list of detail objects that further clarify the reason for the error.

            Not every error supports more detail.'
          example: []
          items:
            $ref: '#/components/schemas/ErrorDetail'
    ErrorDetail:
      title: Error details
      description: Additional detail about the part of a request body that caused an issue.
      type: object
      x-tags:
      - Errors
      properties:
        location:
          type: string
          example: body
          description: The location where the error caused an issue.
          enum:
          - query
          - body
          - path
          - header
        type:
          type: string
          example: value_error.missing
          description: A unique identifier for the type of error that occurred.
        pointer:
          type: string
          example: /payment_method/number
          description: 'The exact item for which the validation did not succeed. This is a JSON

            pointer for request bodies, while for query, path, and header parameters

            it is the name of the parameter.'
        message:
          type: string
          example: field required
          description: A human readable message for this error detail.
    RoleAssignments:
      title: Role Assignments
      type: object
      description: A list of role assignments.
      x-tags:
      - Roles
      properties:
        items:
          type: array
          description: A list of role assignments.
          items:
            $ref: '#/components/schemas/RoleAssignment'
        limit:
          type: integer
          description: 'The limit applied to request. This represents the number of items that are at

            maximum returned by this request.'
          format: int32
          minimum: 1
          maximum: 100
          example: 1
          default: 20
        next_cursor:
          type:
          - string
          - 'null'
          description: 'The cursor that represents the next page of results. Use the `cursor` query

            parameter to fetch this page of items.'
          example: ZXhhbXBsZTE
          minLength: 1
          maxLength: 1000
        previous_cursor:
          type:
          - string
          - 'null'
          description: 'The cursor that represents the next page of results. Use the `cursor` query

            parameter to fetch this page of items.'
          example: null
          minLength: 1
          maxLength: 1000
    Error409DuplicateRecord:
      title: Duplicate Record Error
      type: object
      description: Duplicate Record Error (HTTP 409).
      x-tags:
      - Errors
      properties:
        type:
          type: string
          description: '`error`.'
          enum:
          - error
          example: error
        code:
          type: string
          description: '`duplicate_record`.'
          example: duplicate_record
          enum:
          - duplicate_record
        status:
          type: integer
          description: '`409`.'
          example: 409
          enum:
          - 409
        message:
          type: string
          description: Further details on the field that triggered the error.
          example: A duplicate record exists with this external_identifier value
        details:
          type: array
          description: 'A list of detail objects that further clarify the reason for the error.

            Not every error supports more detail.'
          example: []
          items:
            $ref: '#/components/schemas/ErrorDetail'
    RoleAssignment:
      title: Role Assignment
      type: object
      x-tags:
      - Roles
      properties:
        type:
          type: string
          description: The type of this resource. Always `role-assignment`.
          example: role-assignment
          enum:
          - role-assignment
        id:
          type: string
          format: uuid
          description: The unique ID for this role assignment.
          example: 1cdac457-400f-4866-8da6-5c193a8db158
        role:
          $ref: '#/components/schemas/Role'
        assignee:
          type: object
          description: The assignee for this role assignment.
          properties:
            type:
              type: string
              description: The type of the assignee.
              example: user
              enum:
              - user
            id:
              type: string
              format: uuid
              description: The unique ID of the assignee.
              example: 42aae896-8ce2-4a60-b80a-5f6ae1dfbbd4
    Error401Unauthorized:
      title: Unauthorized Error
      type: object
      description: Unauthorized Error (HTTP 401).
      x-tags:
      - Errors
      properties:
        type:
          type: string
          description: '`error`.'
          enum:
          - error
          example: error
        code:
          type: string
          description: '`unauthorized`.'
          example: unauthorized
          enum:
          - unauthorized
        status:
          type: integer
          description: '`401`.'
          example: 401
          enum:
          - 401
        message:
          type: string
          description: No valid API authentication found.
          example: No valid API authentication found
          enum:
          - No valid API authentication found
        details:
          type: array
          description: 'A list of detail objects that further clarify the reason for the error.

            Not every error supports more detail.'
          example: []
          items:
            $ref: '#/components/schemas/ErrorDetail'
    Roles:
      title: Roles
      type: object
      description: A list of roles.
      x-tags:
      - Roles
      properties:
        items:
          type: array
          description: A list of roles.
          items:
            $ref: '#/components/schemas/Role'
        limit:
          type: integer
          description: 'The limit applied to request. This represents the number of items that are at

            maximum returned by this request.'
          format: int32
          minimum: 1
          maximum: 100
          example: 1
          default: 20
        next_cursor:
          type:
          - string
          - 'null'
          description: 'The cursor that represents the next page of results. Use the `cursor` query

            parameter to fetch this page of items.'
          example: ZXhhbXBsZTE
          minLength: 1
          maxLength: 1000
        previous_cursor:
          type:
          - string
          - 'null'
          description: 'The cursor that represents the next page of results. Use the `cursor` query

            parameter to fetch this page of items.'
          example: null
          minLength: 1
          maxLength: 1000
    Role:
      title: Role
      type: object
      x-tags:
      - Roles
      properties:
        type:
          type: string
          description: The type of this resource. Always `role`.
          example: role
          enum:
          - role
        id:
          type: string
          format: uuid
          description: The unique ID for this role.
          example: 462ab2e2-3e29-44bd-b39f-e4d1293affbb
        name:
          type: string
          description: The unique name for this role.
          example: Support
        description:
          type: string
          description: The description for this role.
          example: Customer support agents
        permissions:
          $ref: '#/components/schemas/RolePermissions'
    Error400BadRequest:
      title: Bad Request
      type: object
      description: Bad Request (HTTP 400).
      x-tags:
      - Errors
      properties:
        type:
          type: string
          description: '`error`.'
          enum:
          - error
          example: error
        code:
          type: string
          description: A short code that describes the reason for the error.
          example: bad_request
          enum:
          - bad_request
          - incorrect_json
          - invalid_credentials
        status:
          type: integer
          description: '`400`.'
          example: 400
          enum:
          - 400
        message:
          type: string
          description: A human-readable reason for the error.
          example: Missing '****' field
        details:
          type: array
          description: A list of detail objects that further clarify the reason for the error.
          items:
            $ref: '#/components/schemas/ErrorDetail'
    Error401:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `unauthorized`
          default: unauthorized
          examples:
          - unauthorized
        status:
          type: integer
          title: Status
          description: Always `401`.
          default: 401
          examples:
          - 401
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: No valid API authentication found
          examples:
          - No valid API authentication found
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail_2'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error401
    Error404:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `not_found`
          default: not_found
          examples:
          - not_found
        status:
          type: integer
          title: Status
          description: Always `404`.
          default: 404
          examples:
          - 404
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: The resource could not be found
          examples:
          - The resource could not be found
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail_2'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error404
    ErrorLocation:
      type: string
      enum:
      - query
      - body
      - path
      - header
      - unknown
      title: ErrorLocation
    Error425:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `too_early`
          default: too_early
          examples:
          - too_early
        status:
          type: integer
          title: Status
          description: Always `425`.
          default: 425
          examples:
          - 425
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail_2'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error425
    RoleAssigneeType:
      type: string
      enum:
      - user
      - api-key-pair
      title: RoleAssigneeType
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ErrorDetail_2:
      properties:
        location:
          $ref: '#/components/schemas/ErrorLocation'
          description: The part of the request where the property can be found that caused the error.
          examples:
          - body
        pointer:
          anyOf:
          - type: string
            format: json-pointer
          - type: string
          title: Pointer
          description: A JSON pointer for the particular property that caused the error.
          examples:
          - /currency
        message:
          type: string
          title: Message
          description: A human-readdable explanation of the error.
          examples:
          - 'Unknown ISO 4217 currency code: USX'
        type:
          type: string
          title: Type
          description: The type of error that was raised for this property.
          examples:
          - value_error
      additionalProperties: false
      type: object
      required:
      - location
      - pointer
      - message
      - type
      title: ErrorDetail
    Error405:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `method_not_allowed`
          default: method_not_allowed
          examples:
          - method_not_allowed
        status:
          type: integer
          title: Status
          description: Always `405`.
          default: 405
          examples:
          - 405
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Method Not Allowed
          examples:
          - Method Not Allowed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail_2'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error405
    Error429:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `too_many_requests`
          default: too_many_requests
          examples:
          - too_many_requests
        status:
          type: integer
          title: Status
          description: Always `429`.
          default: 429
          examples:
          - 429
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail_2'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error429
    Role_2:
      properties:
        type:
          type: string
          const: role
          title: Type
          description: Always `role`.
          default: role
          examples:
          - role
        id:
          type: string
          format: uuid
          title: Id
          description: The unique ID for the role.
          examples:
          - fe26475d-ec3e-4884-9553-f7356683f7f9
        name:
          type: string
          title: Name
          description: The human-readable name of the role.
          examples:
          - Administrator
        slug:
          type: string
          title: Slug
          description: The unique, human-readable identifier for the role.
          examples:
          - administrator
        description:
          type: string
          title: Description
          description: A description of the access this role grants.
          examples:
          - Full read and write access.
        permissions:
          $ref: '#/components/schemas/PermissionSet'
          description: The permissions granted by this role.
        assignable_to:
          items:
            $ref: '#/components/schemas/RoleAssigneeType'
          type: array
          title: Assignable To
          description: The types of resource this role can be assigned to.
        applies_to:
          items:
            type: string
          type: array
          title: Applies To
          description: The slugs of the roles this role is an add-on of. Empty when this role is not an add-on.
        is_standalone_assignable:
          type: boolean
          title: Is Standalone Assignable
          description: Whether this role can be assigned on its own, without being combined with another role.
      additionalProperties: false
      type: object
      required:
      - id
      - name
      - slug
      - description
      - permissions
      - assignable_to
      - applies_to
      - is_standalone_assignable
      title: Role
    Collection_Role_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Role_2'
          type: array
          title: Items
          description: A list of items returned for this request.
        limit:
          type: integer
          maximum: 100.0
          minimum: 1.0
          title: Limit
          description: The number of items for this page.
          default: 20
          examples:
          - 20
        next_cursor:
          anyOf:
          - type: string
            maxLength: 1000
            minLength: 1
          - type: 'null'
          title: Next Cursor
          description: The cursor pointing at the next page of items.
          examples:
          - ZXhhbXBsZTE
        previous_cursor:
          anyOf:
          - type: string
            maxLength: 1000
            minLength: 1
          - type: 'null'
          title: Previous Cursor
          description: The cursor pointing at the previous page of items.
          examples:
          - Xkjss7asS
      additionalProperties: false
      type: object
      required:
      - items
      title: Collection[Role]
    Error500:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `server_error`
          default: server_error
          examples:
          - server_error
        status:
          type: integer
          title: Status
          description: Always `500`.
          default: 500
          examples:
          - 500
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Request could not be processed
          examples:
          - Request could not be processed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail_2'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error500
    Error504:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `gateway_timeout`
          default: gateway_timeout
          examples:
          - gateway_timeout
        status:
          type: integer
          title: Status
          default: 504
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Request could not be processed
          examples:
          - Request could not be processed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail_2'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error504
    Error400:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `bad_request`
          default: bad_request
          examples:
          - bad_request
        status:
          type: integer
          title: Status
          description: Always `400`.
          default: 400
          examples:
          - 400
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail_2'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error400
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Error502:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `bad_gateway`
          default: bad_gateway
          examples:
          - bad_gateway
        status:
          type: integer
          title: Status
          description: Always `502`.
          default: 502
          examples:
          - 502
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Request could not be processed
          examples:
          - Request could not be processed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail_2'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error502
    PermissionSet:
      properties:
        allow:
          items:
            type: string
          type: array
          title: Allow
          description: The scopes granted by this role.
          examples:
          - - transactions.read
            - reports.read
      additionalProperties: false
      type: object
      required:
      - allow
      title: PermissionSet
      description: The permissions granted by a role.
    Error409:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `duplicate_record`
          default: duplicate_record
          examples:
          - duplicate_record
        status:
          type: integer
          title: Status
          description: Always `409`.
          default: 409
          examples:
          - 409
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail_2'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
        resource_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Id
          description: The ID of the conflicting resource.
          examples:
          - cdc70639-cb9c-4222-a73f-b8ce39f7821b
      additionalProperties: false
      type: object
      title: Error409
    Error403:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `forbidden`
          default: forbidden
          examples:
          - forbidden
        status:
          type: integer
          title: Status
          description: Always `403`.
          default: 403
          examples:
          - 403
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail_2'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error403
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes:
            embed: Shorthand for all gr4vy embed related scopes
            sessions.refresh: Refresh access-token
            anti-fraud-service-definitions.read: Read Anti Fraud Service Definitions
            anti-fraud-services.read: Read Anti Fraud Services
            api-key-pairs.read: Read API Key Pairs
            api-logs.read: Read API Logs
            apple-pay-certificates.read: Read Apple Pay Certificates
            audit-logs.read: Read Audit Logs
            bin-checker.read: Read BIN Checker
            buyers.read: Read Buyers
            buyers.billing-details.read: Read Billing Details
            card-scheme-definitions.read: Read Card Scheme Definitions
            checkout-sessions.read: Read Checkout Sessions
            connections.read: Read Connections
            digital-wallets.read: Read Digital Wallets
            flows.read: Read Flows
            gift-card-service-definitions.read: Read Gift Card Service Definitions
            gift-card-services.read: Read Gift Card Services
            gift-cards.read: Read Gift Cards
            merchant-accounts.read: Read Merchant Accounts
            payment-links.read: Read Payment Links
            payment-method-definitions.read: Read Payment Method Definitions
            payment-methods.read: Read Payment Methods
            payment-options.read: Read Payment Options
            payment-service-definitions.read: Read Payment Service Definitions
            payment-services.read: Read Payment Service
            payouts.read: Read Payouts
            reports.read: Read Reports
            roles.read: Read Roles
            three-ds-scenarios.read: Read 3DS Scenarios
            transactions.read: Read Transactions
            users.me.read: Read User Profile
            vault-forward.read: Read Vault Forward
            vault-forward-authentications.read: Read Vault Forward Authentications
            vault-forward-configs.read: Read Vault Forward Configurations
            vault-forward-definitions.read: Read Vault Forward Definitions
            webhook-subscriptions.read: Read Webhook Subscriptions
            business-contexts.read: Read Business Contexts
            health-dashboard.read: Read Health Dashboard
            metrics-explorer.read: Read Metrics Explorer
            monitoring.read: Read Monitoring
            reset.read: Read Reset
            sessions.read: Read Sessions
            users.read: Read Users
            anti-fraud-service-definitions.write: Write Anti Fraud Service Definitions
            anti-fraud-services.write: Write Anti Fraud Services
            api-key-pairs.write: Write API Key Pairs
            api-logs.write: Write API Logs
            apple-pay-certificates.write: Write Apple Pay Certificates
            audit-logs.write: Write Audit Logs
            bin-checker.write: Write BIN Checker
            buyers.write: Write Buyers
            buyers.billing-details.write: Write Billing Details
            card-scheme-definitions.write: Write Card Scheme Definitions
            checkout-sessions.write: Write Checkout Sessions
            connections.write: Write Connections
            digital-wallets.write: Write Digital Wallets
            flows.write: Write Flows
            gift-card-service-definitions.write: Write Gift Card Service Definitions
            gift-card-services.write: Write Gift Card Services
            gift-cards.write: Write Gift Cards
            merchant-accounts.write: Write Merchant Accounts
            payment-links.write: Write Payment Links
            payment-method-definitions.write: Write Payment Method Definitions
            payment-methods.write: Write Payment Methods
            payment-options.write: Write Payment Options
            payment-service-definitions.write: Write Payment Service Definitions
            payment-services.write: Write Payment Service
            payouts.write: Write Payouts
            reports.write: Write Reports
            roles.write: Write Roles
            three-ds-scenarios.write: Write 3DS Scenarios
            transactions.write: Write Transactions
            users.me.write: Write User Profile
            vault-forward.write: Write Vault Forward
            vault-forward-authentications.write: Write Vault Forward Authentications
            vault-forward-configs.write: Write Vault Forward Configurations
            vault-forward-definitions.write: Write Vault Forward Definitions
            webhook-subscriptions.write: Write Webhook Subscriptions
            business-contexts.write: Write Business Contexts
            health-dashboard.write: Write Health Dashboard
            metrics-explorer.write: Write Metrics Explorer
            monitoring.write: Write Monitoring
            reset.write: Write Reset
            sessions.write: Write Sessions
            users.write: Write Users
          tokenUrl: auth/token
x-refined-from:
- gr4vy-docs-v1-openapi.json
- gr4vy-openapi.json