Bot
The English user guide is currently in beta preview. Most of the documents have been automatically translated from the Japanese version. Should you find any inaccuracies, please reach out to Flatt Security.
A bot is a non-human principal in a Shisho Cloud organization. Like a user, a bot can be assigned organization roles and act on the organization's resources; unlike a user, it has no email address or password, and it is meant to be driven by automation rather than a person.
When to use a bot
Create a bot whenever a script, CI/CD pipeline, or another service needs to call Shisho Cloud without a person clicking through a browser sign-in. Typical cases:
- Deploying and syncing workflows (audit rules) between a Git repository and Shisho Cloud, as in Managing Rules with SCM.
- Minting per-developer registry tokens for Takumi Guard's admin deployment.
- Any other unattended, programmatic access to Shisho Cloud through the shishoctl CLI or its API.
Using a bot instead of a shared personal account keeps automation access auditable and independently revocable. You can scope a bot's roles to exactly what the automation needs, and rotate or delete its credentials without touching any human's account.
How a bot fits Shisho Cloud
A bot is created and managed at the organization level, from the bots list page in organization settings. Once created, it behaves like any other organization principal:
- Roles - Assign it one or more organization roles, the same roles you'd assign to a user or a team. Grant only what the automation needs — for example, the least-privilege
organization/takumi_guard_token_issuerrole for a bot that only mints Guard tokens. - Authentication - A bot signs in through a machine-friendly path instead of a browser: a static API key, or an OIDC ID token exchanged with GitHub Actions, GitLab CI, or any other OIDC-Discovery-compliant identity provider. See Authentication for how to set each of these up.
Next steps
- Authentication - choose and configure how your bot signs in.
- shishoctl CLI - the tool most bots use to operate on Shisho Cloud once signed in.
- Roles and Permissions - the full list of organization roles you can assign to a bot.