Get Users (GQL)

post

https://api.cloud.mbanq.com/graphql (Get Users)

Note: All the User Management API's have the endpoint: /graphql

Returns a paginated list of users. Use where to filter and page to paginate.

Requires read permission on the APPUSER resource.

Body Params

Following are the details on the GraphQL fields :

Parameter	Description	Mandatory	Data Type	Example
where.id.EQ	Filter by user id	No	Long	`12`
where.username	Filter by username (`EQ` or `LIKE`)	No	String	`{LIKE: "john"}`
where.roles.id.EQ	Filter by assigned role id	No	Long	`5`
where.OR	Match any of `username`, `email`, `firstName`, `lastName` (`LIKE`) or `mobile` (`EQ`)	No	Object	`{firstName: {LIKE: "John"}}`
where.AND	Match all of `selfServiceUser`, `enabled`, `deleted` (`EQ`) or `authorizations.client.id` (`EQ`)	No	Object	`{selfServiceUser: {EQ: true}}`
page.limit	Maximum number of results	No	Long	`10`
page.start	Offset to start from	No	Long	`0`

Headers

tenantId

string

required

Defaults to z01j3e71zd6zkq908vyf5861a8

The ID of your banking instance visible in the MBANQ Console.

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Paginated list of users.