anikeen/id
1
0 Fork 0
mirror of https://github.com/anikeen-com/id.git synced 2026-11-05 07:09:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add product and reseller scopes

Browse Source
This commit is contained in:
Maurice Preuß committed 2026-11-04 23:27:25 +01:00
1 parent 0ed6934da3
commit d99512a359
5 files changed
+120
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+21
View File
@@ -160,6 +160,27 @@ if ($result->success()) {
}
```
### Scopes
Scopes follow one schema: `resource` grants full access, `resource:read` read-only access and
`resource:client` access to what the app or token created itself. All of them are constants on
`Anikeen\Id\Enums\Scope`, e.g. `Scope::ORDERS_READ`.
The Anikeen Console accepts personal access tokens and OAuth tokens (no client credentials) with
these scopes for its product and reseller APIs:
| Scope | Constant | Grants |
|-------|----------|--------|
| `products:read` | `Scope::PRODUCTS_READ` | view the products of your teams |
| `products` | `Scope::PRODUCTS` | full access to the products of your teams |
| `reseller-customers:read` | `Scope::RESELLER_CUSTOMERS_READ` | view a reseller team's customers and invitations |
| `reseller-customers` | `Scope::RESELLER_CUSTOMERS` | manage customers: invite, resend, remove logins (includes reading) |
| `reseller-grants` | `Scope::RESELLER_GRANTS` | grant customers access to products and revoke it |
| `reseller-orders` | `Scope::RESELLER_ORDERS` | order products for customers, charged right away |
A full scope includes reading. `user` and `*` do not open the reseller endpoints: the token has to
carry the reseller scope itself.
### Change the default access token / refresh token field name
If your access / refresh token fields differ from the default `anikeen_id_access_token` / `anikeen_id_refresh_token`, you can specify the field name in the `AppServiceProvider` boot method: