Child pages
  • Admin API Method listUser

This documentation is for a previous version of Flexiant Cloud Orchestrator. The most recent version is v5.0. For the most recent documentation please see here

Skip to end of metadata
Go to start of metadata

Description
This function searches for a list of existing users.
Style
Document
Input (Literal)
The input of this method is the argument listUser of type listUser having the structure defined by the following table.

Element

Type

Occurs

Description

searchFilter

searchFilter

0..1

The search filter to be used

queryLimit

queryLimit

0..1

The query limit to be used

Output (Literal)
The output of this method is the argument listUserResponse of type listUserResponse having the structure defined by the following table.

Element

Type

Occurs

Description

listUsers

listResult

0..1

The list of users matching the filter

Remarks
On an exception, no users are returned.
The users searched for are specified by the searchFilter and the queryLimit specified by the caller. For documentation on how the filter and query limit work, see the complex types searchFilter and queryLimit.
Each user represents a set of contact information within the system, with associated permissions to access the virtual resources of a customer (or, in some editions, more than one customer). Users should be distinguished from customers, which own virtual resources. For more details, see the user complex type.

  • No labels