SAP SuccessFactors User API

openapi: 3.1.0
info:
  title: SAP SuccessFactors HXM Suite OData EmpEmployment User API
  description: 'Representative subset of the SAP SuccessFactors HXM Suite OData APIs

    (v2 and v4) covering common Employee Central entities such as User,

    PerPerson, EmpEmployment, EmpJob, and FOCompany. Authentication uses

    OAuth 2.0 SAML bearer assertion or HTTP Basic against the tenant''s

    OData service root.

    '
  version: v2
  contact:
    name: SAP SuccessFactors
    url: https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM
servers:
- url: https://{apiServer}/odata/v2
  description: SuccessFactors OData V2 service root
  variables:
    apiServer:
      default: api.successfactors.com
      description: Tenant data center API host (e.g. api4.successfactors.com).
- url: https://{apiServer}/odata/v4
  description: SuccessFactors OData V4 service root
  variables:
    apiServer:
      default: api.successfactors.com
security:
- oauth2: []
- basicAuth: []
tags:
- name: User
paths:
  /User:
    get:
      summary: List users
      operationId: listUsers
      parameters:
      - $ref: '#/components/parameters/Select'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Top'
      - $ref: '#/components/parameters/Skip'
      - $ref: '#/components/parameters/Format'
      responses:
        '200':
          description: OData collection of users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ODataCollection'
      tags:
      - User
components:
  parameters:
    Filter:
      name: $filter
      in: query
      schema:
        type: string
    Format:
      name: $format
      in: query
      schema:
        type: string
        enum:
        - json
        - xml
    Skip:
      name: $skip
      in: query
      schema:
        type: integer
    Select:
      name: $select
      in: query
      schema:
        type: string
    Top:
      name: $top
      in: query
      schema:
        type: integer
  schemas:
    ODataCollection:
      type: object
      properties:
        d:
          type: object
          properties:
            results:
              type: array
              items:
                type: object
                additionalProperties: true
            __next:
              type: string
        '@odata.context':
          type: string
        value:
          type: array
          items:
            type: object
            additionalProperties: true
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.successfactors.com/oauth/token
          scopes: {}
      description: OAuth 2.0 SAML bearer assertion flow.
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic auth with username@companyId and password.