farmOS · Authentication Profile

Farmos Authentication

Authentication

farmOS secures its APIs with oauth2 across 2 declared security schemes, as derived from its OpenAPI definitions. OAuth 2.0 is offered via the authorizationCode and clientCredentials flow(s).

AgricultureFarm ManagementOpen SourceJSON:APIRecord KeepingSelf-HostedDrupal
Methods: oauth2 Schemes: 2 OAuth flows: authorizationCode, clientCredentials API key in:

Security Schemes

oauth2AuthorizationCode oauth2
· flows: authorizationCode
oauth2ClientCredentials oauth2
· flows: clientCredentials

Source

Authentication Profile

Raw ↑ 
generated: '2026-07-11'
method: derived
source: openapi/farmos-farmos-api-openapi.yml
summary:
  types:
  - oauth2
  oauth2_flows:
  - authorizationCode
  - clientCredentials
schemes:
- name: oauth2AuthorizationCode
  type: oauth2
  flows:
  - flow: authorizationCode
    authorizationUrl: /oauth/authorize
    tokenUrl: /oauth/token
    scopes: 3
  description: |-
    OAuth2 Authorization Code grant for third-party integrations. Users
    authorize the client application to access their farmOS data.
  sources:
  - openapi/farmos-farmos-api-openapi.yml
- name: oauth2ClientCredentials
  type: oauth2
  flows:
  - flow: clientCredentials
    tokenUrl: /oauth/token
    scopes: 3
  description: |-
    OAuth2 Client Credentials grant for machine-to-machine authentication.
    Used when no user account is required.
  sources:
  - openapi/farmos-farmos-api-openapi.yml