Personal Access Tokens (PATs) allow external applications and scripts to access the APIs of the Cloudogu EcoSystem. A PAT is associated with a user account and can be restricted to selected Dogus.
\n\n\nA PAT is a secret credential and must be treated like a password. Store the token securely and do not share it with other people.
\n
You must be logged in to the Cloudogu EcoSystem to manage PATs. You can only view, create, and delete your own access tokens.
\nThe overview shows each token's display name, status, creation date, and expiry date. Active and expired tokens are marked accordingly. You can sort the list using the column headings.
\nClick a token's display name to view its details and the Dogus it can access. The actual token value cannot be displayed again after creation.
\nDefine the scope under Applies to:
\nFor security reasons, select only the Dogus the application actually needs and prefer a limited validity period.
\nAfter creation, a dialog displays the new access token. Copy the complete token and store it in a secure location, such as a secret store or password manager.
\n\n\nImportant: The token is displayed only once. If it is lost, the PAT must be deleted and a new one created.
\n
A PAT is used for API requests via HTTP Basic Authentication:
\nThe following example calls the User Management account API:
\ncurl --user '<username>:<pat>' \\\n 'https://<ces-host>/usermgt/api/account'Avoid embedding the PAT directly in scripts or storing it in plain text in configuration files. Use environment variables or your application's secret management instead. With curl, for example, you can enter the PAT interactively:
curl --user '<username>' \\\n 'https://<ces-host>/usermgt/api/account'Access works only for Dogus included in the PAT's scope during creation. A PAT inherits the permissions of its associated user account; it does not grant additional permissions.
\nDelete a PAT when it is no longer needed, has expired, or may have been exposed.
\nYou can delete a PAT in two ways:
\nThen confirm the deletion in the dialog.
\nOnce deleted, the PAT becomes invalid immediately. Applications using this token can no longer use it to access the system. A deleted PAT cannot be recovered.
\n| Problem | \nPossible cause and solution | \n
|---|---|
The API responds with 401 Unauthorized. | \nCheck the username and PAT. The PAT may have expired or been deleted. | \n
The API responds with 403 Forbidden. | \nThe user account does not have the required permission, or the PAT's scope does not include the requested Dogu. | \n
| A Dogu cannot be selected. | \nCheck whether the Dogu is installed and available. | \n
| The token value is no longer visible. | \nPATs are displayed in full only once. Delete the PAT and create a new one. | \n
| An application loses access after deletion. | \nThis is the expected behavior. If needed, configure the application with a newly created PAT. | \n