Reset Directory Access

Resets a directory's access configuration by removing every explicit grant. Destructive, so the query parameter reset=true is required. Removes the view, update, manage and full-control grants of every user and group, including the creator's grant and the All Members view grant every organization directory receives: learners can no longer find or open the directory (browse and search included) until a view grant, for example All Members, is added again with PATCH. The directory itself, its ownership by the organization and its folder are kept, so organization administrators keep access, and so does anyone with access through the folder. Collaborators listed by /api/v2/skill-plans/{id}/collaborators are not changed. A directory without grants also returns 204.

Required Scope

skill_plans:write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The directory id. A skill plan, role or other kind of plan is not found here; skill plans have their own endpoint.

Query Params
string
enum
required

Must be true to confirm the reset (reset-confirmation-required otherwise).

Allowed:
Responses
204

The directory has no explicit grants.

500

The reset could not be applied (write-failed). Retrying is safe.

503

Access configuration is temporarily unavailable (access-configuration-unavailable): the organization's ReBAC rollout mode could not be read, or the
deployment has no ReBAC engine (the detail says which). Retry later.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json