{ "opencollection": "1.0.0", "info": { "name": "Gravitee.io - Access Management alerts user API", "version": "4.12.0-alpha.3" }, "items": [ { "info": { "name": "user", "type": "folder" }, "items": [ { "info": { "name": "List users for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "q", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "User must have the DOMAIN_USER[LIST] permission on the specified domain or DOMAIN_USER[LIST] permission on the specified environment or DOMAIN_USER[LIST] permission on the specified organization. Each returned user is filtered and contains only basic information such as id and username and displayname. Last login and identity provider name will be also returned if current user has DOMAIN_USER[READ] permission on the domain, environment or organization." }, { "info": { "name": "Create a user on the specified security domain", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the DOMAIN_USER[CREATE] permission on the specified domain or DOMAIN_USER[CREATE] permission on the specified environment or DOMAIN_USER[CREATE] permission on the specified organization" }, { "info": { "name": "Create/update/delete multiple users on the specified security domain", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/bulk", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the DOMAIN_USER[CREATE/UPDATE/DELETE] permission on the specified domain, the environment, or the organization" }, { "info": { "name": "Get a user", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization" }, { "info": { "name": "Update a user", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Delete a user", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[DELETE] permission on the specified domain or DOMAIN_USER[DELETE] permission on the specified environment or DOMAIN_USER[DELETE] permission on the specified organization" }, { "info": { "name": "Get a user audit logs", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/audits", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "from", "value": "", "type": "query" }, { "name": "to", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization" }, { "info": { "name": "Get a user audit log", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/audits/:audit", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "audit", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization" }, { "info": { "name": "Get user certificate credentials", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/cert-credentials", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization" }, { "info": { "name": "Enroll a certificate credential for a user", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/cert-credentials", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the DOMAIN_USER[CREATE] permission on the specified domain or DOMAIN_USER[CREATE] permission on the specified environment or DOMAIN_USER[CREATE] permission on the specified organization" }, { "info": { "name": "Get a user certificate credential", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/cert-credentials/:credential", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "credential", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization" }, { "info": { "name": "Revoke a user certificate credential", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/cert-credentials/:credential", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "credential", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Get a user consents", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/consents", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "clientId", "value": "", "type": "query" } ] }, "docs": "User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization" }, { "info": { "name": "Revoke user consents", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/consents", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "clientId", "value": "", "type": "query" } ] }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Get a user consent", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/consents/:consent", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "consent", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization" }, { "info": { "name": "Revoke a user consent", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/consents/:consent", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "consent", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Get a user credentials", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/credentials", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization" }, { "info": { "name": "Get a user credential", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/credentials/:credential", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "credential", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization" }, { "info": { "name": "Revoke a user credential", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/credentials/:credential", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "credential", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "List users for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/devices", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER_DEVICES[LIST] permission on the specified domain or DOMAIN_USER_DEVICES[LIST] permission on the specified environment or DOMAIN_USER_DEVICES[LIST] permission on the specified organization. " }, { "info": { "name": "Delete a device", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/devices/:device", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "device", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER_DEVICE[DELETE] permission on the specified domain or DOMAIN_USER_DEVICE[DELETE] permission on the specified environment or DOMAIN_USER_DEVICE[DELETE] permission on the specified organization" }, { "info": { "name": "Get a user enrolled factors", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/factors", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization" }, { "info": { "name": "Revoke user factor", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/factors/:factor", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "factor", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Get a user linked identities", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/identities", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization" }, { "info": { "name": "Unlink user identity", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/identities/:identity", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "identity", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Lock a user", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/lock", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Reset password", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/resetPassword", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Get a user roles", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/roles", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "dynamic", "value": "", "type": "query" } ] }, "docs": "User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization" }, { "info": { "name": "Assign roles to a user", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/roles", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Revoke role to a user", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/roles/:role", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "role", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Send registration confirmation email", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/sendRegistrationConfirmation", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Update a user status", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/status", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Unlock a user", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/unlock", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Update a user username", "type": "http" }, "http": { "method": "PATCH", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/username", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "List users of the organization", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/users", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "q", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "User must have the ORGANIZATION_USER[LIST] permission on the specified organization. Each returned user is filtered and contains only basic information such as id and username and displayname. Last login and identity provider name will be also returned if current user has ORGANIZATION_USER[READ] permission on the organization." }, { "info": { "name": "Create a platform user or Service Account", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/users", "params": [ { "name": "organizationId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the ORGANIZATION_USER[READ] permission on the specified organization" }, { "info": { "name": "Create/update/delete platform users or Service Accounts", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/users/bulk", "params": [ { "name": "organizationId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the ORGANIZATION_USER[CREATE/UPDATE/DELETE] permission on the specified organization" }, { "info": { "name": "Get a user", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/users/:user", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the ORGANIZATION_USER[READ] permission on the specified organization" }, { "info": { "name": "Update a user", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/users/:user", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the ORGANIZATION_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Delete a user", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/users/:user", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the ORGANIZATION_USER[DELETE] permission on the specified organization" }, { "info": { "name": "Reset password", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/users/:user/resetPassword", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the ORGANIZATION_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Update a user status", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/users/:user/status", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the ORGANIZATION_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Get tokens of a user", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/users/:user/tokens", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "User must have the ORGANIZATION_USER[READ] permission on the specified organization" }, { "info": { "name": "Generate an account access token for a user", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/users/:user/tokens", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the ORGANIZATION_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Revoke an account access token", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/users/:user/tokens/:tokenId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "tokenId", "value": "", "type": "path" } ] }, "docs": "User must have the ORGANIZATION_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Update a user username", "type": "http" }, "http": { "method": "PATCH", "url": "/management/organizations/:organizationId/users/:user/username", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the ORGANIZATION_USER[UPDATE] permission on the specified organization" }, { "info": { "name": "Get the current user", "type": "http" }, "http": { "method": "GET", "url": "/management/user" }, "docs": "Get the current user" }, { "info": { "name": "Subscribe to the newsletter the authenticated user", "type": "http" }, "http": { "method": "POST", "url": "/management/user/newsletter/_subscribe" }, "docs": "Subscribe to the newsletter the authenticated user" }, { "info": { "name": "Get taglines to display in the newsletter", "type": "http" }, "http": { "method": "GET", "url": "/management/user/newsletter/taglines" }, "docs": "Get taglines to display in the newsletter" }, { "info": { "name": "List notifications received by the current user", "type": "http" }, "http": { "method": "GET", "url": "/management/user/notifications" }, "docs": "List notifications received by the current user" }, { "info": { "name": "Mark User notification as read", "type": "http" }, "http": { "method": "POST", "url": "/management/user/notifications/:notificationId/acknowledge", "params": [ { "name": "notificationId", "value": "", "type": "path" } ] }, "docs": "Mark User notification as read" } ] } ], "bundled": true }