Sanggunian ng API
access
16 mga endpoint sa lugar na ito. Ang bawat isa ay may sariling pahina kasama ang mga parameter nito, ang tugon nito, at isang kahilingan na maaari ninyong patakbuhin.
| Paraan | Path | Ang ginagawa nito | Pahintulot |
|---|---|---|---|
| GET | /v1/access/impersonation/current | The current impersonation status (drives the banner). | Anumang API key |
| POST | /v1/access/impersonation/end | Exit the current impersonation session (revoke). | Anumang API key |
| POST | /v1/access/impersonation/redeem | Exchange a single-use impersonation ticket for a session token. | Walang API key |
| GET | /v1/orgs/{orgId}/auth-policy | Read an org's authentication policy. | org.read |
| PUT | /v1/orgs/{orgId}/auth-policy | Set an org's authentication policy (require MFA). | org.update |
| GET | /v1/orgs/{orgId}/delegated-access | Everybody this organisation has shared sites with, one row per person. | sites.collaborators.manage |
| PUT | /v1/orgs/{orgId}/delegated-access | Set exactly which sites one person holds, and the role on each. | sites.collaborators.manage |
| POST | /v1/orgs/{orgId}/delegated-access/revoke | Revoke one person from every site, or from chosen sites. | sites.collaborators.manage |
| GET | /v1/orgs/{orgId}/members | List the people in an organization. | members.read |
| DELETE | /v1/orgs/{orgId}/members/{userId} | Remove a member and offboard them (docs/35 | members.remove |
| PATCH | /v1/orgs/{orgId}/members/{userId} | Change a member's role. | members.role.assign |
| GET | /v1/orgs/{orgId}/roles | List the roles the caller may grant in an organization. | members.read |
| GET | /v1/sites/{siteId}/collaborator-roles | The per-site roles that may be granted here. | sites.collaborators.manage |
| GET | /v1/sites/{siteId}/collaborators | Who this site is shared with. | sites.collaborators.manage |
| POST | /v1/sites/{siteId}/collaborators | Share this site with one person. | sites.collaborators.manage |
| DELETE | /v1/sites/{siteId}/collaborators/{grantId} | Revoke one person's access to this site. | sites.collaborators.manage |