User Management

Edit online

webMethods API Gateway provides the capability to manage Users, Groups and Access profiles in webMethods API Gateway.

webMethods API Gateway provides the following REST API and the resources to retrieve the User ACL list:

  • GET/rest/apigateway/accessProfiles: Retrieves a list of all access profiles in webMethods API Gateway.
  • POST/rest/apigateway/accessProfiles: Creates an access profile in webMethods API Gateway. The API request body must contain the payload for the access profile.
  • GET/rest/apigateway/accessProfiles/{accessProfileId}: Retrieves the details of an access profile in webMethods API Gateway.
  • PUT/rest/apigateway/accessProfiles/{accessProfileId}: Updates the details of a specified access profile in webMethods API Gateway. The API request body must contain the payload for the updated access profile.
  • DELETE/rest/apigateway/accessProfiles/{accessProfileId}: Deletes an access profile from webMethods API Gateway.
  • GET/rest/apigateway/groups: Retrieves list of all groups in webMethods API Gateway.
  • POST/rest/apigateway/groups: Creates a group in webMethods API Gateway. The API request body must contain the payload for the group.
  • GET/rest/apigateway/groups/{groupId}: Retrieves the details of a group in webMethods API Gateway.
  • PUT/rest/apigateway/groups/{groupId}: Updates the details of a specified group in webMethods API Gateway. The API request body must contain the payload for the updated group.
  • DELETE/rest/apigateway/groups/{groupId}: Deletes a group from webMethods API Gateway.
  • GET/rest/apigateway/users: Retrieves list of all users in webMethods API Gateway.
  • POST/rest/apigateway/users: Creates an user in webMethods API Gateway. The API request body must contain the payload for the user.
  • GET/rest/apigateway/users/{userId}: Retrieves the details of an user in webMethods API Gateway.
  • PUT/rest/apigateway/users/{userId}: Updates the details of a specified user in webMethods API Gateway. The API request body must contain the payload for the updated user.
  • DELETE/rest/apigateway/users/{userId}: Deletes the a specified user in webMethods API Gateway.
  • POST/rest/apigateway/users/authenticate: Authenticates a user in webMethods API Gateway.
  • GET/rest/apigateway/installedLanguages: Retrieves list of installed language packs in webMethods API Gateway.
  • GET/rest/apigateway/is/lockedAccounts: Retrieves the locked user accounts in webMethods API Gateway.
  • POST/rest/apigateway/is/lockedAccounts: Unlocks the locked user accounts by webMethods API Gateway.

For details on the REST API, see https://github.com/SoftwareAG/webmethods-api-gateway/blob/master/apigatewayservices/APIGatewayUserManagementSwagger.json.

For details on sample payloads, import Postman collection from the following link in Postman client: https://github.com/SoftwareAG/webmethods-api-gateway/blob/master/apigatewayservices/postmancollections/apis/user-management/UserManagement.json.