{ "opencollection": "1.0.0", "info": { "name": "Hanko Admin Audit Logs User Management API", "version": "1.2.0" }, "items": [ { "info": { "name": "User Management", "type": "folder" }, "items": [ { "info": { "name": "Get a list of users", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant_id}.hanko.io/admin/users", "params": [ { "name": "page", "value": "", "type": "query", "description": "The page which should be returned" }, { "name": "per_page", "value": "", "type": "query", "description": "The number of returned items" }, { "name": "user_id", "value": "", "type": "query", "description": "A single ID or a comma-separated list of IDs. Only users with the specified IDs are included in the result.\n" }, { "name": "email", "value": "", "type": "query", "description": "Only users with the specified email are included" }, { "name": "sort_direction", "value": "", "type": "query", "description": "The sort direction of the returned list (always sorted by created_at)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a list of users" }, { "info": { "name": "Create a new user", "type": "http" }, "http": { "method": "POST", "url": "https://{tenant_id}.hanko.io/admin/users", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new user" }, { "info": { "name": "Get a user by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant_id}.hanko.io/admin/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the user" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a user by ID" }, { "info": { "name": "Update a user by ID", "type": "http" }, "http": { "method": "PATCH", "url": "https://{tenant_id}.hanko.io/admin/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the user" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Updates a subset of user-level attributes.\n\nOther sub-resources (e.g. emails, credentials) are managed via dedicated endpoints and are not updated via this endpoint.\n" }, { "info": { "name": "Delete a user by ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://{tenant_id}.hanko.io/admin/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the user" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a user by ID" }, { "info": { "name": "Get user details by email", "type": "http" }, "http": { "method": "POST", "url": "https://{tenant_id}.hanko.io/admin/user", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve details for user corresponding to the given `email`." }, { "info": { "name": "Deletes the current user", "type": "http" }, "http": { "method": "DELETE", "url": "https://{tenant_id}.hanko.io/admin/user" }, "docs": "Used to delete the current user. Note that `config.account.allow_deletion` must be set to true." }, { "info": { "name": "Get the current user", "type": "http" }, "http": { "method": "GET", "url": "https://{tenant_id}.hanko.io/admin/me" }, "docs": "Retrieve data for the current user (i.e. the subject of the JWT given in a cookie or as a bearer token)." }, { "info": { "name": "Log out the current user", "type": "http" }, "http": { "method": "POST", "url": "https://{tenant_id}.hanko.io/admin/logout" }, "docs": "Logs out the user by removing the authorization cookie." } ] } ], "bundled": true }