Yarken APIs let you integrate supported Yarken capabilities with external systems, applications, scripts, and automation tools.
Use the APIs to automate supported workflows without requiring a user to complete each action manually in Yarken.
Current availability: The public API currently documents the User API. Additional APIs can be added to this section as they become part of the published API contract.
Access requirement: Only users with the Admin role can use Yarken public APIs. Other roles cannot access Yarken public APIs.
Get started
To call a Yarken API, you need:
-
An active Yarken user with the Admin role.
-
The host name of your Yarken environment.
-
A valid API key. For API key setup and security guidance, see API Keys.
-
The endpoint and request format for the API you want to use.
API base URL
Use the following base URL as the starting point when constructing Yarken public API requests:
https://<YOUR-YARKEN-HOST>/api
Replace <YOUR-YARKEN-HOST> with the host name of your Yarken environment.
Note: The API base URL is not an interactive documentation page. Opening it directly in a browser may not display a webpage. Append the required API endpoint and authenticate the request using your API key.
The current public API version is v1.
For example, the User API base path is:
https://<YOUR-YARKEN-HOST>/api/v1/users
Browser access: API endpoints such as /api/v1/users require authentication. Opening an endpoint directly in a browser does not automatically send your API key.
Authenticate API requests
Yarken uses API keys to authenticate public API requests.
You can provide your API key using the x-token header:
x-token: <YOUR_API_KEY>
You can alternatively use the Authorization header:
Authorization: Bearer <YOUR_API_KEY>
You only need to use one authentication method for a request.
Important: Treat API keys as sensitive credentials. Store them using your organization's approved secrets or credential-management process.
For instructions on generating, storing, and managing API keys, see API Keys.
Available APIs
User API
Integrate user management with identity platforms, integration tools, scripts, or custom applications.
Supported actions:
-
List users
-
Create users
-
Retrieve user details
-
Update users
-
Disable and re-enable users
Interactive API documentation
To browse the published endpoints and test API requests in your browser, open the interactive API documentation from your Yarken environment:
https://<YOUR-YARKEN-HOST>/api/docs
Use /api/docs to authorize with your API key, select an endpoint, enter request values, and run supported requests against your Yarken environment.
Note: Unlike the API base URL and API endpoints, /api/docs is designed to be opened directly in a browser.
OpenAPI specification
Yarken exposes the current OpenAPI 3.0 specification at:
https://<YOUR-YARKEN-HOST>/api/openapi.json
The specification provides the machine-readable definition used by the Yarken API documentation.