If you're building on top of Attlaz's API (i.e using Auth Tokens), you'll need certain scopes to access different API endpoints.

To set the scopes for an integration token, select the scopes from the dropdown. These can be edited later.

To set the scopes for an auth token, check the necessary boxes when creating an auth token.

If you're looking for information on membership roles please visit the membership documentation.

Organizations

GETorg:read
PUT/POSTorg:write
DELETEorg:admin

Projects

GETproject:read
PUT/POSTproject:write
DELETEproject:admin
Note

The project:releases scope will give you access to both project and organization release endpoints. The available endpoints are listed in the Releases section of the API Documentation.

Teams

GETteam:read
PUT/POSTteam:write
DELETEteam:admin

Members

GETmember:read
PUT/POSTmember:write
DELETEmember:admin

Issues & Events

GETevent:read
PUTevent:write
DELETEevent:admin
Note

PUT/DELETE methods only apply to updating/deleting issues. Events in Attlaz are immutable and can only be deleted by deleting the whole issue.

Releases

GET/PUT/POST/DELETEproject:releases
Note

Be aware that if you're using attlaz-cli to manage your releases, you'll need a token which also has org:read scope.

Need more information?

As our platform is always evolving and is full customizable, it is not possible to provide all information here. Don't hesitate to reach out to our team if you have any questions or want more information about certain topics.