Decisiv Internal Users API

openapi: 3.2.0
info:
  title: Decisiv Internal Users API
  version: 0.48.24
  contact:
    name: Decisiv Support
    email: support@decisiv.com
    url: https://www.decisiv.com
  license:
    name: Proprietary
    identifier: proprietary
    url: https://www.decisiv.com/terms-of-use/
  termsOfService: https://www.decisiv.com/terms-of-use
  description: 'Operations tagged Internal Users across 2 of this provider''s published API definitions: decisiv-asset-management-openapi.yml, decisiv-service-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://srm-api.staging.decisivapps.com
- url: https://srm-api.decisivapps.com
security:
- OAuth2AuthorizationCode: []
  AccessToken: []
- OAuth2Password: []
  AccessToken: []
tags:
- name: Internal Users
paths:
  /asset_management/{srm_account_id}/v1/internal_users:
    get:
      summary: List details all Internal Users
      operationId: listInternalUsers
      description: Lists the fleet users that are assignable to cases for the requested account.
      tags:
      - Internal Users
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: filter[external_reference.business_system]
        in: query
        required: false
        schema:
          type: string
          minLength: 1
        description: Filters users by the exact match of the external reference business system
      responses:
        '200':
          description: Returns a list of internal_users
          content:
            application/vnd.api+json:
              example:
                data:
                - id: 6383dc89-05b6-4572-8979-a6257f3597ec
                  type: internal_users
                  attributes:
                    first_name: Joe
                    last_name: Ramone
                    email: joe-ramone@decisivgenerated.email
                    external_reference:
                      business_system: '123'
                meta:
                  record-count: 1
              schema:
                $ref: '#/components/schemas/internal_users'
        '400':
          description: This response may occur when an invalid request has been provided to the server.  The request may be corrected by the consumer and resubmitted.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Filter not allowed
                  detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}'
                  code: decisiv:filters:001
                  status: '400'
                  source:
                    parameter: filter[filter_name]
              schema:
                $ref: '#/components/schemas/errors_response'
        '401':
          description: This response may occur when the access token provided within the Authorization token has expired.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Access unauthorized
                  detail: Access unauthorized
                  code: decisiv::access_token:001
                  status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Forbidden
                  detail: User does not have permission to perform this action on the requested resource(s)
                  code: decisiv:access:001
                  status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '424':
          description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Failed Dependency
                  detail: Failed Dependency
                  code: '424'
                  status: '424'
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '504'
                  detail: Gateway timeout error
                  status: '504'
                  title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /asset_management/{srm_account_id}/v1/internal_users/{id}:
    get:
      summary: List details on a specific Internal User
      operationId: getInternalUser
      description: Returns details for a specific fleet user by ID.
      tags:
      - Internal Users
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: id
        in: path
        schema:
          type: string
          format: uuid
        description: The resource UUID
        required: true
      responses:
        '200':
          description: Show details for Internal User
          content:
            application/vnd.api+json:
              example:
                data:
                  id: 6383dc89-05b6-4572-8979-a6257f3597ec
                  type: internal_users
                  attributes:
                    first_name: Joe
                    last_name: Ramone
                    email: joe-ramone@decisivgenerated.email
                    external_reference:
                      business_system: '123'
              schema:
                $ref: '#/components/schemas/internal_user'
        '401':
          description: This response may occur when the access token provided within the Authorization token has expired.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Access unauthorized
                  detail: Access unauthorized
                  code: decisiv::access_token:001
                  status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Forbidden
                  detail: User does not have permission to perform this action on the requested resource(s)
                  code: decisiv:access:001
                  status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '404':
          description: This response may occur when the requested resource is not found.
          content:
            application/vnd.api+json:
              example:
                errors:
                - status: '404'
                  code: decisiv:resource:001
                  title: Resource Identifier - Not Found
                  detail: The parent resource could not be found
                  source:
                    parameter: id
              schema:
                $ref: '#/components/schemas/errors_response'
        '424':
          description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Failed Dependency
                  detail: Failed Dependency
                  code: '424'
                  status: '424'
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '504'
                  detail: Gateway timeout error
                  status: '504'
                  title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /service_management/{srm_account_id}/v1/internal_users:
    get:
      summary: List details all Internal Users
      tags:
      - Internal Users
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: filter[permissions:includes]
        in: query
        required: false
        schema:
          type: string
          minLength: 1
        description: Filters users for the given permission assigned, using exact matching search
      - name: filter[external_reference.business_system]
        in: query
        required: false
        schema:
          type: string
          minLength: 1
        description: Filters users by the exact match of the external reference business system
      responses:
        '200':
          description: Returns a list of internal_users
          content:
            application/vnd.api+json:
              example:
                data:
                - id: 6383dc89-05b6-4572-8979-a6257f3597ec
                  type: internal_users
                  attributes:
                    first_name: Joe
                    last_name: Ramone
                    email: joe-ramone@decisivgenerated.email
                    permissions:
                    - service_management:CreateCustomers
                    - service_management:ReadCustomers
                    - service_management:ModifyCustomers
                    - service_management:ReadCases
                    - service_management:CreateCases
                    - service_management:ModifyCases
                    - service_management:ReadCustomerAssets
                    - service_management:ModifyCustomerAssets
                    - service_management:CreateCustomerAssets
                    - service_management:CreateCaseMetadata
                    - service_management:ReadApplicableOperations
                    - service_management:ModifyCustomerNumber
                    external_reference:
                      business_system: '123'
                meta:
                  record-count: 1
              schema:
                $ref: '#/components/schemas/internal_users'
        '401':
          description: This response may occur when the access token provided within the Authorization token has expired.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Access unauthorized
                  detail: Access unauthorized
                  code: decisiv::access_token:001
                  status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Forbidden
                  detail: User does not have permission to perform this action on the requested resource(s)
                  code: decisiv:access:001
                  status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '424':
          description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Failed Dependency
                  detail: Failed Dependency
                  code: '424'
                  status: '424'
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '504'
                  detail: Gateway timeout error
                  status: '504'
                  title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
  /service_management/{srm_account_id}/v1/internal_users/{id}:
    get:
      summary: List details on a specific Internal User
      tags:
      - Internal Users
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: id
        in: path
        schema:
          type: string
          format: uuid
        description: The resource UUID
        required: true
      responses:
        '200':
          description: Show details for Internal User
          content:
            application/vnd.api+json:
              example:
                data:
                  id: 6383dc89-05b6-4572-8979-a6257f3597ec
                  type: internal_users
                  attributes:
                    first_name: Joe
                    last_name: Ramone
                    email: joe-ramone@decisivgenerated.email
                    permissions:
                    - service_management:CreateCustomers
                    - service_management:ReadCustomers
                    - service_management:ModifyCustomers
                    - service_management:ReadCases
                    - service_management:CreateCases
                    - service_management:ModifyCases
                    - service_management:ReadCustomerAssets
                    - service_management:ModifyCustomerAssets
                    - service_management:CreateCustomerAssets
                    - service_management:CreateCaseMetadata
                    - service_management:ReadApplicableOperations
                    - service_management:ModifyCustomerNumber
                    external_reference:
                      business_system: '123'
              schema:
                $ref: '#/components/schemas/internal_user_2'
        '400':
          description: This response may occur when an invalid request has been provided to the server.  The request may be corrected by the consumer and resubmitted.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Filter not allowed
                  detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}'
                  code: decisiv:filters:001
                  status: '400'
                  source:
                    parameter: filter[filter_name]
              schema:
                $ref: '#/components/schemas/errors_response'
        '401':
          description: This response may occur when the access token provided within the Authorization token has expired.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Access unauthorized
                  detail: Access unauthorized
                  code: decisiv::access_token:001
                  status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Forbidden
                  detail: User does not have permission to perform this action on the requested resource(s)
                  code: decisiv:access:001
                  status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '404':
          description: This response may occur when the requested resource is not found.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Record not found
                  detail: The requested record or one of its relationships could not be found
                  code: '404'
                  status: '404'
              schema:
                $ref: '#/components/schemas/errors_response'
        '424':
          description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Failed Dependency
                  detail: Failed Dependency
                  code: '424'
                  status: '424'
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '504'
                  detail: Gateway timeout error
                  status: '504'
                  title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
    servers:
    - url: https://srm-api.staging.decisivapps.com
    - url: https://srm-api.decisivapps.com
components:
  schemas:
    error_response:
      type: object
      properties:
        status:
          type: string
        title:
          type: string
        detail:
          type:
          - string
          - 'null'
        code:
          type:
          - string
          - 'null'
        source:
          type: object
          properties:
            parameter:
              type:
              - string
              - 'null'
            pointer:
              type:
              - string
              - 'null'
        links:
          type: object
          description: Links related to this error (e.g. documentation reference).
          additionalProperties:
            type: string
            format: uri
      required:
      - status
      - title
    internal_user_properties-data:
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
          - internal_users
        attributes:
          type: object
          properties:
            first_name:
              type: string
              description: First name of the internal user
              maxLength: 50
            last_name:
              type: string
              description: Last name of the internal user
              maxLength: 50
            email:
              type: string
              description: Email of the internal user
              maxLength: 120
            external_reference:
              type: object
              description: Reference Identifiers used outside of Decisiv SRM
              properties:
                business_system:
                  type:
                  - string
                  - 'null'
                  description: Business System Identifier
      required:
      - attributes
      - type
      - id
    internal_user:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
            type:
              type: string
              enum:
              - internal_users
            attributes:
              type: object
              properties:
                first_name:
                  type: string
                  description: First name of the internal user
                  maxLength: 50
                last_name:
                  type: string
                  description: Last name of the internal user
                  maxLength: 50
                email:
                  type: string
                  description: Email of the internal user
                  maxLength: 120
                external_reference:
                  type: object
                  description: Reference Identifiers used outside of Decisiv SRM
                  properties:
                    business_system:
                      type:
                      - string
                      - 'null'
                      description: Business System Identifier
          required:
          - attributes
          - type
          - id
    errors_response:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/error_response'
      required:
      - errors
    internal_users:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/internal_user_properties-data'
        meta:
          type: object
          properties:
            record-count:
              type: integer
              description: Total count across all pages
    internal_user_properties-data_2:
      type: object
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          enum:
          - internal_users
        attributes:
          type: object
          properties:
            first_name:
              type: string
              description: First name of the internal user
              maxLength: 50
            last_name:
              type: string
              description: Last name of the internal user
              maxLength: 50
            email:
              type: string
              description: Email of the internal user
              maxLength: 120
            external_reference:
              type: object
              description: Reference Identifiers used outside of Decisiv SRM
              properties:
                business_system:
                  type:
                  - string
                  - 'null'
                  description: Business System Identifier
            permissions:
              type: array
              description: A list of permissions for the user.
              items:
                type: string
                description: Name of the permission
              minItems: 1
      required:
      - attributes
      - type
      - id
    internal_user_2:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
            type:
              type: string
              enum:
              - internal_users
            attributes:
              type: object
              properties:
                first_name:
                  type: string
                  description: First name of the internal user
                  maxLength: 50
                last_name:
                  type: string
                  description: Last name of the internal user
                  maxLength: 50
                email:
                  type: string
                  description: Email of the internal user
                  maxLength: 120
                external_reference:
                  type: object
                  description: Reference Identifiers used outside of Decisiv SRM
                  properties:
                    business_system:
                      type:
                      - string
                      - 'null'
                      description: Business System Identifier
                permissions:
                  type: array
                  description: A list of permissions for the user.
                  items:
                    type: string
                    description: Name of the permission
                  minItems: 1
          required:
          - attributes
          - type
          - id
  securitySchemes:
    AccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
    OAuth2AuthorizationCode:
      type: oauth2
      description: OAuth 2.0 Authorization Code flow. This is the required flow for new integrations. See https://api-docs.decisiv.net/docs/api/oauth/
      flows:
        authorizationCode:
          authorizationUrl: https://login.decisiv.net/auth/api_gateway
          tokenUrl: https://login.decisiv.net/oauth/token
          refreshUrl: https://login.decisiv.net/oauth/token
          scopes: {}
    OAuth2Password:
      type: oauth2
      description: '**Deprecated.** OAuth 2.0 Password flow. New integrations must use the Authorization Code flow (`OAuth2AuthorizationCode`); this flow remains available only during the migration window and will be removed in a future release. See https://api-docs.decisiv.net/docs/api/oauth/'
      flows:
        password:
          tokenUrl: https://login.decisiv.net/oauth/token
          scopes: {}
x-refined-from:
- decisiv-asset-management-openapi.yml
- decisiv-service-management-openapi.yml