Symmetry Authentication

generated: '2026-10-21'
method: searched
generator: extract-docs-artifacts.py (local)
source: https://docs.symmetry.com/spf/getting-started/authentication.md
sources:
- https://docs.symmetry.com/spf/getting-started/authentication.md
- https://docs.symmetry.com/i9/core-concepts/authentication.md
- https://docs.symmetry.com/cbs/core-concepts/authentication-model.md
- https://docs.symmetry.com/i9/api-reference/admin/generate-a-token-for-an-admin-to-access-the-i9-system.md
description: Authentication schemes for Symmetry products as documented.
schemes:
- type: http-basic
  name: Basic authentication for proxy endpoints
  evidence: To use basic authentication in the schema for proxy endpoints, set the "authType" value to "BASIC" within the nested webservice.proxy.authentication
    element
  location: header
  header: Authorization
  how_to_obtain: Provide username and password in the proxy authentication configuration.
- type: oauth2
  name: OAuth 2.0 client credentials for postback data
  evidence: To use OAuth 2.0 authentication using grant type client credentials in the schema for postback data, configure your SPF Registration
  how_to_obtain: Set oauth2GrantType to CLIENT_CREDENTIALS and provide oauth2ClientId, oauth2ClientSecret, and oauth2AuthServerUrl in the registration.
- type: oauth2
  name: OAuth 2.0 password grant for postback data
  evidence: To use OAuth 2.0 authentication using grant type password credentials in the schema for postback data, configure your SPF Registration
  how_to_obtain: Set oauth2GrantType to PASSWORD and provide oauth2ClientId, oauth2ClientSecret, username, password, and oauth2AuthServerUrl in
    the registration.
- type: http-bearer
  name: JWT bearer token for SPF API
  evidence: The encrypted JWT token is to be included in each request to the SPF-API as a Bearer token in the Authorization header
  location: header
  header: Authorization
  authorize_url: https://api.symmetry.com/authentication/login
  how_to_obtain: Make a GET request to https://api.symmetry.com/authentication/login with the api-key header containing your API Key or Hash;
    the response returns an accessToken.
- type: apiKey
  name: API key for I‑9 login endpoint
  evidence: To request a new JWT access token, make an HTTP GET request to the URL below, setting the api-key header to the API Key or Hash provided
    by Symmetry.
  location: header
  header: api-key
  authorize_url: https://api.symmetry.com/authentication/login
  how_to_obtain: Include the provided API key in the api-key header when calling the login endpoint; the response returns an accessToken used
    as a Bearer token.
docs: https://docs.symmetry.com/spf/getting-started/authentication.md
note: 1 extracted row(s) were dropped because their quote was not on the page.