Factset Users API

openapi: 3.2.0
info:
  title: Factset Users API
  version: '1.0'
  description: 'Operations tagged Users across 5 of this provider''s published API definitions: factset-irn-configuration-api-openapi.yml, factset-procure-to-pay-scim-openapi.yml, factset-vermilion-api-openapi.yml, irn-configuration-openapi-original.yml, procure-to-pay-api-scim-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.factset.com/research/irn
  description: Production Server
- url: https://api-sandbox.factset.com/research/irn
  description: Sandbox
- url: https://api.factset.com/scim/v2/
  description: Production environment
- url: https://api.uat.factset.com/scim/v2/
  description: UAT environment
tags:
- name: Users
paths:
  /v1/users:
    get:
      tags:
      - Users
      summary: Get All Assigned Factset Users
      operationId: GetAssignedFactSetUsers
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserConfigDto'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - basicScheme: []
    servers:
    - url: https://api.factset.com/research/irn
      description: Production Server
    - url: https://api-sandbox.factset.com/research/irn
      description: Sandbox
  /Users:
    get:
      tags:
      - Users
      summary: Factset Get a List of Users.
      security:
      - basicAuth: []
      parameters:
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/startIndex'
      - $ref: '#/components/parameters/count'
      - $ref: '#/components/parameters/attributes'
      - $ref: '#/components/parameters/excludedAttributes'
      responses:
        '200':
          $ref: '#/components/responses/usersSuccess'
        '400':
          $ref: '#/components/responses/invalidFilterError'
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '403':
          $ref: '#/components/responses/forbiddenError'
        '500':
          $ref: '#/components/responses/internalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      tags:
      - Users
      summary: Factset Create a User.
      security:
      - basicAuth: []
      requestBody:
        $ref: '#/components/requestBodies/userResource'
      responses:
        '201':
          $ref: '#/components/responses/userSuccess'
        '400':
          $ref: '#/components/responses/invalidResourceProvidedError'
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '403':
          $ref: '#/components/responses/forbiddenError'
        '500':
          $ref: '#/components/responses/internalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://api.factset.com/scim/v2/
      description: Production environment
    - url: https://api.uat.factset.com/scim/v2/
      description: UAT environment
  /Users/{id}:
    get:
      tags:
      - Users
      summary: Factset Get a User.
      security:
      - basicAuth: []
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          $ref: '#/components/responses/userSuccess'
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '403':
          $ref: '#/components/responses/forbiddenError'
        '404':
          $ref: '#/components/responses/userNotFoundError'
        '500':
          $ref: '#/components/responses/internalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      tags:
      - Users
      summary: Factset Replace a User.
      security:
      - basicAuth: []
      parameters:
      - $ref: '#/components/parameters/resourceId'
      requestBody:
        $ref: '#/components/requestBodies/userResource'
      responses:
        '200':
          $ref: '#/components/responses/userSuccess'
        '400':
          $ref: '#/components/responses/invalidResourceProvidedError'
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '403':
          $ref: '#/components/responses/forbiddenError'
        '404':
          $ref: '#/components/responses/userNotFoundError'
        '500':
          $ref: '#/components/responses/internalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      tags:
      - Users
      summary: Factset Patch a User (add, Replace, or Remove Attributes of a User.)
      security:
      - basicAuth: []
      parameters:
      - $ref: '#/components/parameters/resourceId'
      requestBody:
        $ref: '#/components/requestBodies/patchUserResource'
      responses:
        '200':
          $ref: '#/components/responses/userSuccess'
        '400':
          $ref: '#/components/responses/invalidPatchRequestError'
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '403':
          $ref: '#/components/responses/forbiddenError'
        '500':
          $ref: '#/components/responses/internalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      tags:
      - Users
      summary: Factset Delete a User
      security:
      - basicAuth: []
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '204':
          description: User successfully deleted.
        '401':
          $ref: '#/components/responses/unauthorizedError'
        '403':
          $ref: '#/components/responses/forbiddenError'
        '404':
          $ref: '#/components/responses/userNotFoundError'
        '500':
          $ref: '#/components/responses/internalServerError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    servers:
    - url: https://api.factset.com/scim/v2/
      description: Production environment
    - url: https://api.uat.factset.com/scim/v2/
      description: UAT environment
  /scim/v2/Users:
    get:
      operationId: getAllUsers
      tags:
      - Users
      summary: Factset Retrieves a List of Vrs Users
      description: Retrieves a list of VRS users
      parameters:
      - in: query
        name: count
        description: Non-negative maximum number of entries to return
        schema:
          type: integer
        examples:
          count:
            value: 25
            description: Non-negative maximum number of entries to return
      - in: query
        name: startIndex
        description: The 1-based index of the first query result
        schema:
          type: integer
        examples:
          startIndex:
            value: 1
            description: The 1-based index of the first query result
      responses:
        '200':
          description: Successful operation
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ScimUserListResponse'
        '403':
          description: Forbidden, user does not have permission to view users
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ScimError'
              example:
                schemas:
                - urn:ietf:params:scim:api:messages:2.0:Error
                detail: User does not have view or update permission
                status: '403'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - FactSetApiKey: []
      - FactSetOAuth2: []
    post:
      operationId: createUser
      tags:
      - Users
      summary: Factset Creates a User
      description: Creates a VRS user
      requestBody:
        required: true
        content:
          application/scim+json:
            schema:
              $ref: '#/components/schemas/CreateScimUserJSONRequest'
      responses:
        '201':
          description: Created
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/CreatedScimUserJSONResponse'
          headers:
            Location:
              schema:
                type: string
              description: A callback URL to the newly create user, for example https://example.com/VRSAPI/scim/v2/Users/1
        '400':
          description: Bad Request, required values not provided in JSON request body (e.g. tenant, name or userName (loginID)
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ScimError'
              example:
                schemas:
                - urn:ietf:params:scim:api:messages:2.0:Error
                detail: No tenant code given
                status: '400'
        '403':
          description: Forbidden, user does not have permission to create users or it does not have requested tenancy assigned to it
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ScimError'
              example:
                schemas:
                - urn:ietf:params:scim:api:messages:2.0:Error
                detail: User does not have update permission for users
                status: '403'
        '409':
          description: User already exists
          content:
            application/scim+json:
              schema:
                $ref: '#/components/schemas/ScimError'
              example:
                schemas:
                - urn:ietf:params:scim:api:messages:2.0:Error
                detail: User already exists
                status: '409'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - FactSetApiKey: []
      - FactSetOAuth2: []
components:
  schemas:
    UserConfigDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: abc123
        userName:
          type:
          - string
          - 'null'
          example: example_value
        serialNumber:
          type:
          - string
          - 'null'
          example: example_value
        firstName:
          type:
          - string
          - 'null'
          example: example_value
        lastName:
          type:
          - string
          - 'null'
          example: example_value
        emailAddress:
          type:
          - string
          - 'null'
          example: user@example.com
        team:
          $ref: '#/components/schemas/TeamSummaryDto'
      additionalProperties: false
    TeamSummaryDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: abc123
        name:
          type:
          - string
          - 'null'
          example: Example Title
        code:
          type:
          - string
          - 'null'
          example: example_value
      additionalProperties: false
    Patch:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          example: []
        Operations:
          type: array
          items:
            type: object
            properties:
              op:
                type: string
              path:
                type: string
              value:
                type: string
          example: []
    UserResourceList:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          example:
          - urn:ietf:params:scim:api:messages:2.0:ListResponse
        totalResults:
          type: integer
          example: 1
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/UserResource'
          example: []
    LocationResourceReference:
      type: object
      properties:
        value:
          type: string
          description: Identifier of the Location.
          example: '1598276'
        $ref:
          type: string
          description: The URI corresponding to a SCIM resource that is this Location.
          example: https://api.factset.com/scim/v2/Locations/1598276
        display:
          type: string
          description: A human-readable name, primarily used for display purposes.
          example: FIN Wealth Management
      required:
      - value
    PendingProductOrder:
      type: object
      properties:
        product:
          $ref: '#/components/schemas/ProductResourceReference'
        type:
          type: string
          description: Type of product order, e.g. 'Add' or 'Remove'.
          example: Add
          readOnly: true
        status:
          type: string
          description: Status of the pending product order.
          example: Processing
          readOnly: true
        requested:
          type: string
          description: Date and time when product was ordered.
          example: '2019-06-07T08:59:37+00:00'
          readOnly: true
      required:
      - product
      - type
      - status
      - requested
    ProductResourceReference:
      type: object
      properties:
        value:
          type: string
          example: '6781'
        $ref:
          type: string
          example: https://api.factset.com/scim/v2/Products/6781
        display:
          type: string
          example: FactSet Identity
      required:
      - value
    UserResource:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          example:
          - urn:ietf:params:scim:schemas:core:2.0:User
          - urn:scim:schemas:extension:FactSet:Core:1.0:User
          - urn:scim:schemas:extension:FactSet:VRS:1.0:User
        id:
          type: string
          readOnly: true
          example: FIN_WEALTH-123456
        externalId:
          type: string
          example: C3574707-FFF9-433C-A17F-DFF806C72A7F
        userName:
          type: string
          description: Unique identifier for the User, typically used by the user to directly authenticate to the service provider. Each User MUST include a non-empty userName value.  This identifier MUST be unique across the service provider's entire set of Users.
          readOnly: true
          example: FIN_WEALTH-123456
        name:
          type: object
          description: The components of the user's real name. Providers MAY return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both.  If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.
          properties:
            familyName:
              type: string
              description: The family name of the User, or last name in most Western languages (e.g., 'Jensen' given the full name 'Ms. Barbara J Jensen, III').
              example: Doe
            givenName:
              type: string
              description: The given name of the User, or first name in most Western languages (e.g., 'Barbara' given the full name 'Ms. Barbara J Jensen, III').
              example: John
          required:
          - familyName
          - givenName
          example: Example Title
        email:
          type: string
          description: Email addresses for the user.  The value SHOULD be canonicalized by the service provider, e.g., 'bjensen@example.com' instead of 'bjensen@EXAMPLE.COM'.
          example: jdoe@factset.com
        phoneNumbers:
          type: array
          description: Phone numbers for the User.  The value SHOULD be canonicalized by the service provider according to the format specified in RFC 3966, e.g., 'tel:+1-201-555-0123'. Canonical type values of 'main', 'work', 'mobile', and 'home'.
          items:
            type: object
            properties:
              value:
                type: string
                description: Phone number of the User.
                readOnly: true
                example: tel:5558675309
              display:
                type: string
                description: A human-readable name, primarily used for display purposes.  READ-ONLY.
                readOnly: true
                example: (555) 867-5309
              type:
                type: string
                description: A label indicating the attribute's function, e.g., 'work', 'home', 'mobile'.
                readOnly: true
                example: work
              primary:
                type: boolean
                description: A Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g., the preferred phone number or primary phone number.  The primary attribute value 'true' MUST appear no more than once.
                readOnly: true
                example: true
          readOnly: true
          example: []
        groups:
          type: array
          description: A list of groups to which the user belongs, either through direct membership, through nested groups, or dynamically calculated.
          items:
            type: object
            properties:
              value:
                type: string
                description: The identifier of the User's group.
                readOnly: true
                example: Domain btud - Pod 04 - CitrixApps - Cymba OMS
              $ref:
                type: string
                description: The URI of the corresponding 'Group' resource to which the user belongs.
                readOnly: true
                example: https://api.factset.com/scim/v2/Groups/Domain%20btud%20-%20Pod%2004%20-%20CitrixApps%20-%20Cymba%20OMS
              display:
                type: string
                description: A human-readable name, primarily used for display purposes.  READ-ONLY.
                readOnly: true
                example: Domain btud - Pod 04 - CitrixApps - Cymba OMS
          readOnly: true
          example: []
        urn:scim:schemas:extension:FactSet:Core:1.0:User:
          type: object
          properties:
            username:
              type: string
              description: A FactSet "username" is FactSet's logical structure for grouping serial numbers into like-groups based on roleName, geographical location or line of business.
              example: FIN_WEALTH
            serialNumber:
              type: string
              description: A serial number represents an individual's unique FactSet account identifier and base-workstation access. Serial numbers are allocated to an individual when a valid RoleName is present.
              readOnly: true
              example: '123456'
            factSetNetId:
              type: string
              description: FactSet.net ID.
              readOnly: true
              example: John.Doe9@factset.net
            location:
              $ref: '#/components/schemas/LocationResourceReference'
            roleName:
              type: string
              description: Predetermined role of specific individual. Issues individual a base FactSet workstation and serial number. If passed as NULL a base-FactSet workstation will be allocated to the individual granting the individual a FactSet SerialNumber
              example: Wealth Manager
            products:
              type: array
              description: An array of FactSet products to allocate/remove from an individual. Individual must have a FactSet serial number associated with them.
              items:
                $ref: '#/components/schemas/ProductResourceReference'
            pendingProductOrders:
              type: array
              description: An array of pending FactSet product orders.
              items:
                $ref: '#/components/schemas/PendingProductOrder'
              readOnly: true
            assertionValue:
              type: string
              description: Field containing the value, passed as nameID, used to assert the identity of an individual via SAML2.0 which maps service-provider-side to a FactSet serial number. Only applicable to individuals with a FactSet serial number with a Federation setup between your domain and FactSet's
              example: exampleAssertionValue
          required:
          - username
          example: example_value
        urn:scim:schemas:extension:FactSet:VRS:1.0:User:
          type: object
          properties:
            domainData:
              type: array
              description: A set of attributes pertaining to individual Vermilion domains.
              items:
                type: object
                properties:
                  domainCode:
                    type: string
                    description: Unique identifier for the Vermilion domain.
                    example: btud
                  tenancies:
                    type: object
                    description: List of tenancies where the User exists in the associated domain.
                    properties:
                      value:
                        type: string
                        description: Name of a tenant.
                        example: MASTER
                    required:
                    - value
                  isAdministrator:
                    type: boolean
                    description: Whether the User is an administrator in the associated domain.
                    example: false
                  password:
                    type: string
                    description: Password of the User in the associated domain. May be null upon creation of the User, but afterward may not change from a non-null to a null value.
                required:
                - domainCode
                - tenancies
                - isAdministrator
          example: example_value
        meta:
          type: object
          properties:
            resourceType:
              type: string
              example: User
            created:
              type: string
              example: '2019-02-11T15:33:31.077+00:00'
            lastModified:
              type: string
              example: '2019-06-07T08:59:37+00:00'
            location:
              type: string
              example: https://api.factset.com/scim/v2/Users/FIN_WEALTH-123456
          readOnly: true
          example: example_value
      required:
      - userName
      - name
      - email
    ScimUserGroup:
      type: object
      properties:
        value:
          type: string
          example: example_value
        $ref:
          type: string
          description: A callback link which can be used to get the information of the user
          example: example_value
        type:
          type: string
          example: example_value
        display:
          type: string
          description: Name of the group
          example: example_value
    ScimEmail:
      type: object
      properties:
        value:
          type: string
          example: example_value
        type:
          type: string
          example: example_value
        primary:
          type: boolean
          example: true
    CreatedScimUserJSONResponse:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          example: []
        id:
          type: integer
          example: abc123
        userName:
          type: string
          example: example_value
        name:
          type: object
          properties:
            formatted:
              type: string
          example: Example Title
        userType:
          type: string
          example: example_value
        preferredLanguage:
          type: string
          example: example_value
        active:
          type: boolean
          example: true
        authenticatedUserName:
          type: string
          example: example_value
        tenant:
          type: string
          example: example_value
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/ScimPhone'
          example: []
        emails:
          type: array
          items:
            $ref: '#/components/schemas/ScimEmail'
          example: user@example.com
        tenancies:
          type: array
          items:
            $ref: '#/components/schemas/Tenancy'
          example: []
        photos:
          type: array
          items:
            $ref: '#/components/schemas/ScimPhoto'
          example: []
        domainCode:
          type: string
          example: example_value
        isAdministrator:
          type: boolean
          example: true
        meta:
          type: object
          properties:
            resourceType:
              type: string
            created:
              type: string
            lastModified:
              type: string
            location:
              type: string
          example: example_value
    ScimUserListResponse:
      type: object
      properties:
        totalResults:
          type: integer
          example: 10
        itemsPerPage:
          type: integer
          example: 10
        startIndex:
          type: integer
          example: 10
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/ScimUser'
          example: []
    ScimPhoto:
      type: object
      properties:
        value:
          type: string
          example: example_value
        type:
          type: string
          example: example_value
        primary:
          type: boolean
          example: true
    Tenancy:
      type: object
      properties:
        value:
          type: string
          example: example_value
    ScimError:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          example: []
        detail:
          type: string
          example: example_value
        status:
          type: string
          example: example_value
    ScimMeta:
      type: object
      properties:
        resourceType:
          type: string
          example: example_value
        created:
          type: string
          example: example_value
        lastModified:
          type: string
          example: example_value
        location:
          type: string
          example: example_value
    ScimPhone:
      type: object
      properties:
        value:
          type: string
          example: example_value
        type:
          type: string
          example: example_value
        primary:
          type: boolean
          example: true
    CreateScimUserJSONRequest:
      type: object
      properties:
        userName:
          type: string
          example: example_value
        password:
          type: string
          example: example_value
        name:
          type: object
          properties:
            formatted:
              type: string
          example: Example Title
        preferredLanguage:
          type: string
          example: example_value
        active:
          type: boolean
          example: true
        authenticatedUserName:
          type: string
          example: example_value
        tenant:
          type: string
          example: example_value
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/ScimPhone'
          example: []
        emails:
          type: array
          items:
            $ref: '#/components/schemas/ScimEmail'
          example: user@example.com
        photos:
          type: array
          items:
            $ref: '#/components/schemas/ScimPhoto'
          example: []
        tenancies:
          type: array
          items:
            $ref: '#/components/schemas/Tenancy'
          example: []
    ScimUser:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          example: []
        id:
          type: integer
          example: abc123
        userName:
          type: string
          example: example_value
        name:
          type: object
          properties:
            formatted:
              type: string
          example: Example Title
        userType:
          type: string
          example: example_value
        active:
          type: boolean
          example: true
        authenticatedUserName:
          type: string
          example: example_value
        tenant:
          type: string
          example: example_value
        phoneNumbers:
          type: array
          items:
            $ref: '#/components/schemas/ScimPhone'
          example: []
        emails:
          type: array
          items:
            $ref: '#/components/schemas/ScimEmail'
          example: user@example.com
        photos:
          type: array
          items:
            $ref: '#/components/schemas/ScimPhoto'
          example: []
        tenancies:
          type: array
          items:
            $ref: '#/components/schemas/Tenancy'
          example: []
        groups:
          type: array
          items:
            $ref: '#/components/schemas/ScimUserGroup'
          example: []
        domainCode:
          type: string
          example: example_value
        isAdministrator:
          type: boolean
          example: true
        meta:
          $ref: '#/components/schemas/ScimMeta'
    UserConfigDto_2:
      type: object
      properties:
        id:
          type: string
          format: uuid
        userName:
          type:
          - string
          - 'null'
        serialNumber:
          type:
          - string
          - 'null'
        firstName:
          type:
          - string
          - 'null'
        lastName:
          type:
          - string
          - 'null'
        emailAddress:
          type:
          - string
          - 'null'
        team:
          $ref: '#/components/schemas/TeamSummaryDto_2'
      additionalProperties: false
    TeamSummaryDto_2:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        code:
          type:
          - string
          - 'null'
      additionalProperties: false
    Patch_2:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
        Operations:
          type: array
          items:
            type: object
            properties:
              op:
                type: string
              path:
                type: string
              value:
                type: string
    UserResourceList_2:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          example:
          - urn:ietf:params:scim:api:messages:2.0:ListResponse
        totalResults:
          type: integer
          example: 1
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/UserResource_2'
    UserResource_2:
      type: object
      properties:
        schemas:
          type: array
          items:
            type: string
          example:
          - urn:ietf:params:scim:schemas:core:2.0:User
          - urn:scim:schemas:extension:FactSet:Core:1.0:User
          - urn:scim:schemas:extension:FactSet:VRS:1.0:User
        id:
          type: string
          readOnly: true
          example: FIN_WEALTH-123456
        externalId:
          type: string
          example: C3574707-FFF9-433C-A17F-DFF806C72A7F
        userName:
          type: string
          description: Unique identifier for the User, typically used by the user to directly authenticate to the service provider. Each User MUST include a non-empty userName value.  This identifier MUST be unique across the service provider's entire set of Users.
          readOnly: true
          example: FIN_WEALTH-123456
        name:
          type: object
          description: The components of the user's real name. Providers MAY return just the full name as a single string in the formatted sub-attribute, or they MAY return just the individual component attributes using the other sub-attributes, or they MAY return both.  If both variants are returned, they SHOULD be describing the same name, with the formatted name indicating how the component attributes should be combined.
          properties:
   

# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/factset/refs/heads/main/openapi/factset-users-api-openapi.yml