Authentication

Obtain Access Token

Exchanges a client ID and client secret for a temporary access token needed for calling Security Onion Connect API methods. The client ID and client secret are provided within the SOC Administration -> API Clients screen, when creating a new API client or when regenerating an API client's secret. The client secrets are only temporarily visible during those two specific times. The returned access token will expire within 1-2 hours, by default. Ensure the custom integration application is capable of exchanging for a new access token prior to the expiration.

post/oauth2/token

Request

The document declares no server URL.
Auth
HTTP basic
TypeScript
https://skmtc.dev/security-onion-solutions/apis/security-onion-connect-api/docs/oauth2/token/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

grant_typestring required

Must be set to client_credentials

Example request

{
  "grant_type": "client_credentials"
}

Response

The access token response object.

access_tokenstring

The access token to be used for all other Connect API requests."

expires_ininteger

Amount of time, in seconds, before the access token expires."

scopestring

Scope will be blank due to the use of application-level RBAC for authorization.

token_typestring

Token type will always be 'bearer' for access token exchanges.

Example response

{
  "access_token": "ory_at_arkgYuJXYp5zwU8Xyh8-URW6QIUbaZVf4JwDPoNZh0g.YcF4W5i2qoQ2RTWZvLYLNIeUjGaUhYuewz9Gua0y7YA",
  "expires_in": 3599,
  "token_type": "bearer"
}

Changes

No recorded changes to this operation across all 23 revisions of this API.