SAP SuccessFactors Oauth API

openapi: 3.1.0
info:
  title: SAP SuccessFactors HXM Suite OData EmpEmployment Oauth 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: Oauth
paths:
  /oauth/token:
    post:
      summary: Exchange a SAML assertion for an OAuth 2.0 access token
      description: 'Issues an OAuth 2.0 access token using the SAML 2.0 bearer

        assertion flow against the SuccessFactors tenant.

        '
      operationId: getOAuthToken
      security: []
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - grant_type
              - assertion
              - client_id
              properties:
                grant_type:
                  type: string
                  enum:
                  - urn:ietf:params:oauth:grant-type:saml2-bearer
                assertion:
                  type: string
                client_id:
                  type: string
                company_id:
                  type: string
                user_id:
                  type: string
                new_token:
                  type: string
      responses:
        '200':
          description: Access token
          content:
            application/json:
              schema:
                type: object
                properties:
                  access_token:
                    type: string
                  token_type:
                    type: string
                  expires_in:
                    type: integer
      tags:
      - Oauth
components:
  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.