Service Credentials¶

"Settings" allows you to create Service Credentials for your Insights Hub environment.
Within the "Service Credentials" tab, you can create a maximum of 3 service credentials.
Service Credentials are valid for Cloud Foundry and cannot be used for Insights Hub APIs.
The Org Manager and Space Developer roles from Cloud Foundry are supported. For more information, refer to the Cloud Foundry documentation.

Requirements¶

You can access the "Service Credentials" tab as an operator or a developer tenant. To get access to this tab and to create service credentials, you need one of the following roles:

• TenantAdmin
• OperatorAdmin
• DeveloperAdmin
• ServiceCredentialAdmin

Service Credential status¶

Your Service Credentials can have the following status:

You can see the status and the types of changes in the history.

User interface "Service Credentials"¶

You can access service credentials via the "Service Credentials" tab inside the "Settings" app. After you have created a Service Credential, the following screen appears:

① Creates a new Service Credential
② Opens the history of all changes made in the last 90 days
③ Refreshes the list of service credentials
④ Shows the name of the selected Service Credential
⑤ Renews the Service Credentials
⑥ Activates or deactivates selected Service Credentials
⑦ Resets the password
⑧ Shows the login information with username and password until the site gets refreshed
⑨ Shows the properties of the selected Service Credentials
⑩ Shows the assigned role to the Service Credentials
⑪ Shows an error indicating that the Service Credentials are not active

Create new Service Credentials¶

This section allows the admins to generate unique access credentials for secure platform usage.

Requirement¶

Ensure to have one of the following roles:

• OperatorAdmin
• DeveloperAdmin

Procedure¶

To create new Service Credentials, proceed as follows:

1. Open "Service Credentials" and click "Create Service Credentials".
2. Enter a client ID, e.g. "robin".

!!! note - The username uses the tenant's name as a prefix. - Only a-z and 0-9 are allowed as characters.

1. Enter a description for the Service Credentials.
   
2. Enter a expiry date for the Service Credentials. The default expiry date is one year.
   
3. Assign a role to the Service Credentials.
   
4. Click "Create Service Credentials".
   
5. Click to copy the username and the password into clipboard.

Result¶

• The Service Credentials are successfully generated.
• After refreshing the site, the "Properties" status switches from "Provisioning" to "Provisioned".
  This credentials are now ready for use.
• You can now login to your Cloud Foundry account with these credentials.

Edit role assignment for Service Credentials¶

You can edit the role assignment of your Service Credentials.

Procedure¶

To edit the role assignment for Service Credentials, proceed as follows:

1. Open "Service Credentials" and select the "Service Credentials" you want to edit.
2. Click "Edit assignment" in the "Roles" tab.
3. Select the roles to be added or deselect the role to be removed and click "Next".
4. Click "Save".

Deactivate Service Credentials¶

You can deactivate Service Credentials to temporarily revoke access for a user.

Pre-requisite¶

Ensure that you have created Service Credentials.

Procedure¶

To deactivate Service Credentials, proceed as follows:

1. Open "Service Credentials" and select the "Service Credentials" to be deactivated.
2. Click "Deactivate Service Credentials".
3. Click "Refresh" to update the provisioning status.

The selected Service Credentials is successfully deactivated and you cannot login to Cloud Foundry with this credential. You can activate the Service Credentials using the above procedure.

Delete Service Credentials¶

You can delete Service Credentials if you no longer need them or if you have reached the limit of remaining Service Credentials.

Pre-requisite¶

Ensure that you have created Service Credentials.

Procedure¶

To delete Service Credentials, proceed as follows:

1. Open "Service Credentials" and select the "Service Credentials" to be deleted.
2. Click "Delete Service Credentials".
3. Click "Delete".

The selected Service Credentials is successfully deleted. The remaining Service Credential number increases.

Renew Service Credentials¶

You can renew expired Service Credentials. By default, the Service Credentials are valid for one year.

Pre-requisites¶

• Ensure that you have created Service Credentials.
• The Service Credentials have the status "Expired".

Procedure¶

To renew expired Service Credentials, proceed as follows:

1. Open "Service Credentials" and select the "Service Credentials" to be renewed.
2. Click "Renew Service Credentials".
3. Enter the new expiry date for the Service Credentials and click "Renew Service Credentials".
4. Click to copy the username and the password into clipboard.

The expired Service Credentials will be successfully renewed with a new password. You need to update the local configurations in which you used these Service Credentials. The status changes to "Renewing Credentials".