Endpoint access
Endpoint access is defined by API roles. An API role is a list of endpoints, operations, and fields that are available to a set of callers when triggering system API calls. For example, API roles determine the following:
- What endpoints and resource types are available to the
caller?
- For example, can a given caller access the
/activitiesendpoint?
- For example, can a given caller access the
- What operations can a caller call on the available endpoint?
- For example, can a caller execute both a GET and a POST on the
/activitiesendpoint?
- For example, can a caller execute both a GET and a POST on the
- What fields can the caller specify in a request payload or get in a response payload?
- For example, can a caller include the
priorityfield in a POST/activitiesor retrieve theassignedUserin a GET/activities?
- For example, can a caller include the
Note: The base configuration includes an internal super user whose user name is
su. This user is not bound by endpoint access. Any authenticated call from
su will have access to all endpoints.