Service Credential
In this page, you will find the steps to generate, revoke, and edit Service Credentials.
What is a Service Credential
A Service Credential allows Enterprise Accounts to generate service tokens with custom Groups and scopes for specific purposes. This way, pipeline-level actions are performed by the organization, not by individual users in a Group.
Account-level operations include the following actions:
-
Resource creation;
-
Execution of specific tasks via pipeline, without the need for direct intervention from a specific user.
For example, you can generate a token with the following information:
- The name of a group called Tech Products.
- Scope permissions to only create and manage Studios.
- Teams responsible for Tech Products.
Requirement
- Only users with Account Holder or Sys_Admin permission can generate Service Credentials. They can be generated at any time in the StackSpot Portal.
Create Service Credentials
For security reasons, credentials such as the Personal Access Token (PAT) are stored encrypted in StackSpot. After being saved, it's not possible to consult or view this information again through the platform.
Step 1. Log in to the StackSpot EDP Portal;
Step 2. Click your profile avatar and select the 'Organization' option;
Step 3. In 'General Settings', click on 'Identity and Security', then click on 'Service Credentials';
Step 4. Click the 'Create Service Credential' button;
Step 5. Fill in the 'Credential Name' field and click the 'Next' button;
Step 6. Add Groups to your Credential. This is an optional step, and you can edit this step later.
-
To add a Group, click the 'Add Groups' button, select the Groups, and click 'Add'. Then, click 'Next';
-
To add later, click the 'Skip' button.
Step 7. In 'Summary', review your information and click the 'Save' button.
Done, you've generated a Service Credential.
In 'Client ID and Client Key', copy your information:
- Client Id
- Client Secret
- Realm
After you click the 'Finish' button, you will not be able to view this data again.
Edit Service Credentials
The Groups of a Credential are the only variable you can edit after creation.
To edit a Service Credential, follow the steps below:
Step 1. Still in 'Service Credentials', click the Credential you want to edit;
Step 2. To remove Groups from your Credential, click the 'Remove' button. To confirm, click 'OK';
Step 3. To add Groups, click the 'Add Groups' button and select which ones you want to add. To confirm, click 'Add'.
Revoke Service Credentials
Only users with Account Holder or Sys_Admin permission can revoke Credentials.
It's recommended to create a new Credential before revoking the current one.
Step 1. Still in 'Service Credentials', click the Credential you want to revoke;
Step 2. Now click the 'Revoke' button;
Step 3. Enter the name of the Credential in the 'Credential name' field.
Step 4. To confirm, click the 'Revoke' button.
Done, you've revoked a Service Credential.