farmOS · OAuth Scopes

farmOS OAuth Scopes

OAuth 2.0 derived

farmOS publishes 3 OAuth 2.0 scopes via the authorizationCode and clientCredentials flows. Scopes are the fine-grained permissions an application requests at authorization time to act against the farmOS API on a user’s behalf.

Tokens are issued from /oauth/token.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

AgricultureFarm ManagementOpen SourceJSON:APIRecord KeepingSelf-HostedDrupal

Scopes: 3 Flows: authorizationCode, clientCredentials Method: derived

OAuth endpoints

Authorization URL
/oauth/authorize

Token URL
/oauth/token

Flows
authorizationCodeclientCredentials

Scopes (3)

Scope	Description	Flows
farm_manager	Full management access to the farm	authorizationCode, clientCredentials
farm_viewer	Read-only access to farm records	authorizationCode, clientCredentials
farm_worker	Worker-level access to farm records	authorizationCode, clientCredentials

📄 Provider scope reference:

Source

OAuth Scopes

generated: '2026-07-11'
method: derived
source: openapi/farmos-farmos-api-openapi.yml
schemes:
- name: oauth2AuthorizationCode
  source: openapi/farmos-farmos-api-openapi.yml
  flows:
  - flow: authorizationCode
    authorizationUrl: /oauth/authorize
    tokenUrl: /oauth/token
  description: |-
    OAuth2 Authorization Code grant for third-party integrations. Users
    authorize the client application to access their farmOS data.
- name: oauth2ClientCredentials
  source: openapi/farmos-farmos-api-openapi.yml
  flows:
  - flow: clientCredentials
    tokenUrl: /oauth/token
  description: |-
    OAuth2 Client Credentials grant for machine-to-machine authentication.
    Used when no user account is required.
scopes:
- scope: farm_manager
  description: Full management access to the farm
  flows:
  - authorizationCode
  - clientCredentials
  sources:
  - openapi/farmos-farmos-api-openapi.yml
- scope: farm_viewer
  description: Read-only access to farm records
  flows:
  - authorizationCode
  - clientCredentials
  sources:
  - openapi/farmos-farmos-api-openapi.yml
- scope: farm_worker
  description: Worker-level access to farm records
  flows:
  - authorizationCode
  - clientCredentials
  sources:
  - openapi/farmos-farmos-api-openapi.yml