Generate an API Key for a User

If you want to ...

You need to ...

Generate/Manage API Key

Navigate to Designer Menu path separator Security Menu path separator API Keys to create new or view the list of API Keys generated:

  • Define a Key Name that reflects the purpose, e.g., HR Interface
  • Assign a user in Created For. The user must have sufficient security permissions to perform the required activities against the SAI360 database.
  • Copy the API Key and save it securely outside of the Web Application BEFORE saving the record. On save, the Key will no longer be available and cannot be retrieved.

Users must have or inherit to security role Policy Role – Maintain API Keys to be able to create or manage API Keys.

API REQUEST HEADERS

To access the Rest API, all calls must provide an API Key as an HTTP Request Header.

The header name must be "APIKey" and the value must be the actual API Key string, generated from SAI360 (EHS&S).

See Also

Rest API

Rest API - Introduction

Add Components to Rest API

GET (Read) Operations

PATCH (Write) Operations

POST (Create) Operations

CREATE or UPDATE Users with Rest API

CREATE DBFiles/Files with Rest API