Privileges Required to use API Keys

To use API Key, you need one of the following:

• scheduler-administrator or redwood-administrator role.
• scheduler-user or redwood-login role in combination with the following system-wide, partition-wide or object-level privileges.

Built-in Roles

• The scheduler-administrator or redwood-administrator built-in role provides full control over all API keys.
• The scheduler-user built-in role provides full control over the user's API keys.

Creating API Keys

You need all of the following privilege ranks to be able to create key:

• View - on the partitions Redwood and GLOBAL.
• View - on applications GLOBAL.Redwood and REDWOOD.ApiKeyAuthentication.
• View - on library REDWOOD.Redwood_ApiKeyAuthenticationLib.
• View or any other rank - on the Redwood_ApiKeyAuthentication extension point.
• Edit - on ApiKey.

note

Administrators can create API keys for any user, regular users can only create API keys for themselves.

Using API Keys

You need all of the following privilege ranks to be able to use an API key:

• View - on the partitions Redwood and GLOBAL.
• View - on applications GLOBAL.Redwood and REDWOOD.ApiKeyAuthentication.
• View - on library REDWOOD.Redwood_ApiKeyAuthenticationLib.
• View or any other rank - on the Redwood_ApiKeyAuthentication extension point.
• Edit - on ApiKey, this object is modified by users each time the API key is used.

Modifying API Keys

You cannot modify an API key.

Deleting API Keys

• View - on the partitions Redwood and GLOBAL.
• View - on applications GLOBAL.Redwood and REDWOOD.ApiKeyAuthentication.
• View - on library REDWOOD.Redwood_ApiKeyAuthenticationLib.
• View or any other rank - on the Redwood_ApiKeyAuthentication extension point.
• Edit - on ApiKey.

note

Administrators can delete API keys for any user, regular users can only delete their own API keys.

See Also

• API Key Component
• Privileges Required to use Applications
• Privileges Required to use Objects