SERVICE ACCOUNTS Tab

Prev Next

This section provides information on Service Accounts and the tasks that can be performed with it in ZPE Cloud.

A service account is a special type of non-human account used by applications, workloads, or system components to authenticate and interact with ZPE Cloud APIs without user intervention. Instead of representing a person, it represents the identity of a process that can a perform an action in ZPE Cloud. The services account authentication in ZPE Cloud uses API keys that simplifies workflows by not requiring explicity previous logins and makes it easy to integrate enterprise, orchestration and monitoring tools.

The Services accounts authentication works with the API keys being provided on the header of the REST API request with the following format: 'Authorization: Bearer <API Key>', in which, the <API Key> can be replaced by your actual Service Account key. Example as per: 'Authorization: Bearer zpe_cloud_FaaBBqaSS7SrOnKrq2KS3sFW19S9oB0s9Q0xrLXs5e8' . This means, the Service Account is not required to login to ZPE Cloud to perform an action as a normal user would do and the API key already authenticates and authorizes the account.

Note that the Service accounts permissions are based on the Group the account is part of and only an Administrator can access and manage accounts on this page.

Note

For more information on how to use Service Accounts in ZPE Cloud through the API, check ZPE Cloud API Resources

Add a Service Account

This section provides information on how to add Service Accounts:

  1. Go to USERS::SERVICE ACCOUNTS

  2. Click ADD 

  3. Enter the Name of the Service Account

    NOTE

    The domain is generated using a company identifier to ensure uniqueness. Enter the desired name that will be associated with the company identifier to be unique within a company.

  4. Select the group from the Groups drop-down

    NOTE

    For more information on creating or editing a group for a user, see the Groups section.

  5. Click SAVE

    Alert

    After creating the Service Account, it is necessary to save and store the API Key as it will not be available after exiting the current screen.

Add an Expiration to a Service Account

When adding a new Service Account it is possible to add an expiration date for the account to expire:

  1. Go to USERS::SERVICE ACCOUNTS

  2. Click ADD

  3. Enter the Name of the Service Account

    NOTE

    The domain is generated using a company identifier to ensure uniqueness. Enter the desired name.

  4. Select the group from the Groups drop-down

    NOTE

    For more information on creating or editing a group for a user, see the Groups section.

  5. Check the Expiration Date checkbox

  6. Select the Expiration Date

  7. Click SAVE

Edit a Service Account

  1. Go to USERS::SERVICE ACCOUNTS

  2. In the table, locate the service account and select the checkbox

  3. Click EDIT

Note

It is possible to edit the service account in 3 different ways:

  1. Edit the service account by adding an expiration date

  2. Edit the group of the service account

  3. Generate a new key for the service account

Edit the Service Account by Adding an Expiration Date

  1. Check the Expiration Date checkbox

  2. Select the Expiration Date

  3. Click SAVE

Edit the Group of the Service Account

  1. Select the group/groups from the Groups drop-down

  2. click SAVE

Generate a New Key for the Service Account

  1. Click on GENERATE A NEW KEY

  2. COPY or DOWNLOAD the new key

    Alert

    After editing the Service Account, it is necessary to save and store the API Key as it will not be available after exiting the current screen

Delete a Service Account

  1. Go to USERS::SERVICE ACCOUNTS

  2. In the table, locate the user and select the checkbox

  3. Click DELETE

    A confirmation box is displayed

  4. Click DELETE to confirm

Lock a Service Account

This disables the Service Account

  1. Go to USERS::SERVICE ACCOUNTS

  2. In the table, locate the user and select the checkbox

  3. Click LOCK

    A confirmation box is displayed

  4. Click LOCK to confirm

If the account needs to be reactivated, it's only necessary to select it and click the UNLOCK button

Unlock a Service Account

This enables the Locked Service Account

  1. Go to USERS::SERVICE ACCOUNTS

  2. In the table, locate the locked user and select the checkbox

  3. Click UNLOCK

    A confirmation box is displayed

  4. Click UNLOCK to confirm