Screendragon API Authentication

• OAuth 2.0 – Client Credentials Grant
• OAuth 2.0 – Authorization Code Grant
• Basic Authorization with API Key

Supported Authentication Modes

Screendragon API supports three authentication mechanisms to suit different integration needs and security models. Each mode requires specific credentials and setup, which can be obtained by contacting your account manager.

OAuth 2.0 – Client Credentials Grant

Best for: Server-to-server integrations with no user interaction.

How It Works

• Authenticate using Client ID and Client Secret.
• Request an access token from the authorization server.
• Use the token to access protected API endpoints.

Request Example

POST /oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&
client_id=YOUR_CLIENT_ID&
client_secret=YOUR_CLIENT_SECRET

Setup Requirements

To use this mode, please contact your account manager to obtain:

• Client ID
• Client Secret
• Access Token URL

OAuth 2.0 – Authorization Code Grant

Best for: Applications requiring user login and consent (e.g., web or mobile apps).

How It Works

• Redirect the user to the authorization server.
• Prompt the user to log in and grants access.
• Receive an authorization code from the authorization server after the user grants access.
• Exchange the code for an access token by sending it to the token endpoint.

Token Exchange Example

POST /oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=authorization_code&
code=AUTHORIZATION_CODE&
redirect_uri=YOUR_REDIRECT_URI&
client_id=YOUR_CLIENT_ID&
client_secret=YOUR_CLIENT_SECRET

Setup Requirements

Contact your account manager to obtain the following:

• Client ID
• Client Secret
• Authorization URL
• Callback URL
• System User Details (if applicable)

Basic Authorization with API Key

Best for: Lightweight integrations or internal tools.

How It Works

• Pass the API key in the request header using either Basic Auth or a custom header.

Request Example

GET /api/resource
Authorization: Basic YOUR_API_KEY

Or:

GET /api/resource
x-api-key: YOUR_API_KEY

Setup Requirements

To use this mode, please contact your account manager to obtain:

• API Key