{ "opencollection": "1.0.0", "info": { "name": "Red Hat Ansible Automation Platform Add-Ons Users API", "version": "2.6" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Red Hat List Users", "type": "http" }, "http": { "method": "GET", "url": "https://ansible-platform.example.com/admin/realms/:realm/users", "params": [ { "name": "realm", "value": "", "type": "path", "description": "The name of the Keycloak realm." }, { "name": "username", "value": "example_value", "type": "query", "description": "Filter by username." }, { "name": "email", "value": "user@example.com", "type": "query", "description": "Filter by email address." }, { "name": "firstName", "value": "example_value", "type": "query", "description": "Filter by first name." }, { "name": "lastName", "value": "example_value", "type": "query", "description": "Filter by last name." }, { "name": "enabled", "value": "true", "type": "query", "description": "Filter by enabled status." }, { "name": "first", "value": "10", "type": "query", "description": "The index of the first result to return (pagination offset)." }, { "name": "max", "value": "10", "type": "query", "description": "The maximum number of results to return." } ] }, "docs": "Retrieves a paginated list of users in the specified realm. Results can be filtered by username, email, first name, or last name." }, { "info": { "name": "Red Hat Create a User", "type": "http" }, "http": { "method": "POST", "url": "https://ansible-platform.example.com/admin/realms/:realm/users", "params": [ { "name": "realm", "value": "", "type": "path", "description": "The name of the Keycloak realm." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new user in the specified realm with the provided profile attributes and optional initial credentials." }, { "info": { "name": "Red Hat Get a User", "type": "http" }, "http": { "method": "GET", "url": "https://ansible-platform.example.com/admin/realms/:realm/users/:user_id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "The name of the Keycloak realm." }, { "name": "user_id", "value": "", "type": "path", "description": "The unique identifier of the user." } ] }, "docs": "Retrieves the details of a specific user in the realm." }, { "info": { "name": "Red Hat Update a User", "type": "http" }, "http": { "method": "PUT", "url": "https://ansible-platform.example.com/admin/realms/:realm/users/:user_id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "The name of the Keycloak realm." }, { "name": "user_id", "value": "", "type": "path", "description": "The unique identifier of the user." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the profile attributes of an existing user in the realm." }, { "info": { "name": "Red Hat Delete a User", "type": "http" }, "http": { "method": "DELETE", "url": "https://ansible-platform.example.com/admin/realms/:realm/users/:user_id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "The name of the Keycloak realm." }, { "name": "user_id", "value": "", "type": "path", "description": "The unique identifier of the user." } ] }, "docs": "Deletes a user from the realm along with all associated sessions, consents, and federated identity links." }, { "info": { "name": "Red Hat Get Logged-in User", "type": "http" }, "http": { "method": "GET", "url": "https://ansible-platform.example.com/user/" }, "docs": "Retrieves the information for the currently authenticated user." } ] } ], "bundled": true }