UsersApi
UsersApi Class Doc Comment
Tags
Table of Contents
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- __construct() : mixed
- getConfig() : Configuration
- getNetworkSmUserDeviceProfiles() : object
- Operation getNetworkSmUserDeviceProfiles
- getNetworkSmUserDeviceProfilesAsync() : PromiseInterface
- Operation getNetworkSmUserDeviceProfilesAsync
- getNetworkSmUserDeviceProfilesAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkSmUserDeviceProfilesAsyncWithHttpInfo
- getNetworkSmUserDeviceProfilesWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkSmUserDeviceProfilesWithHttpInfo
- getNetworkSmUsers() : object
- Operation getNetworkSmUsers
- getNetworkSmUsersAsync() : PromiseInterface
- Operation getNetworkSmUsersAsync
- getNetworkSmUsersAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkSmUsersAsyncWithHttpInfo
- getNetworkSmUserSoftwares() : object
- Operation getNetworkSmUserSoftwares
- getNetworkSmUserSoftwaresAsync() : PromiseInterface
- Operation getNetworkSmUserSoftwaresAsync
- getNetworkSmUserSoftwaresAsyncWithHttpInfo() : PromiseInterface
- Operation getNetworkSmUserSoftwaresAsyncWithHttpInfo
- getNetworkSmUserSoftwaresWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkSmUserSoftwaresWithHttpInfo
- getNetworkSmUsersWithHttpInfo() : array<string|int, mixed>
- Operation getNetworkSmUsersWithHttpInfo
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
- getNetworkSmUserDeviceProfilesRequest() : Request
- Create request for operation 'getNetworkSmUserDeviceProfiles'
- getNetworkSmUserSoftwaresRequest() : Request
- Create request for operation 'getNetworkSmUserSoftwares'
- getNetworkSmUsersRequest() : Request
- Create request for operation 'getNetworkSmUsers'
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ]) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
Return values
mixed —getConfig()
public
getConfig() : Configuration
Return values
Configuration —getNetworkSmUserDeviceProfiles()
Operation getNetworkSmUserDeviceProfiles
public
getNetworkSmUserDeviceProfiles(string $network_id, string $user_id) : object
Get the profiles associated with a user
Parameters
- $network_id : string
-
network_id (required)
- $user_id : string
-
user_id (required)
Tags
Return values
object —getNetworkSmUserDeviceProfilesAsync()
Operation getNetworkSmUserDeviceProfilesAsync
public
getNetworkSmUserDeviceProfilesAsync(string $network_id, string $user_id) : PromiseInterface
Get the profiles associated with a user
Parameters
- $network_id : string
-
(required)
- $user_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkSmUserDeviceProfilesAsyncWithHttpInfo()
Operation getNetworkSmUserDeviceProfilesAsyncWithHttpInfo
public
getNetworkSmUserDeviceProfilesAsyncWithHttpInfo(string $network_id, string $user_id) : PromiseInterface
Get the profiles associated with a user
Parameters
- $network_id : string
-
(required)
- $user_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkSmUserDeviceProfilesWithHttpInfo()
Operation getNetworkSmUserDeviceProfilesWithHttpInfo
public
getNetworkSmUserDeviceProfilesWithHttpInfo(string $network_id, string $user_id) : array<string|int, mixed>
Get the profiles associated with a user
Parameters
- $network_id : string
-
(required)
- $user_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkSmUsers()
Operation getNetworkSmUsers
public
getNetworkSmUsers(string $network_id[, array<string|int, string> $ids = null ][, array<string|int, string> $usernames = null ][, array<string|int, string> $emails = null ][, array<string|int, string> $scope = null ]) : object
List the owners in an SM network with various specified fields and filters
Parameters
- $network_id : string
-
network_id (required)
- $ids : array<string|int, string> = null
-
Filter users by id(s). (optional)
- $usernames : array<string|int, string> = null
-
Filter users by username(s). (optional)
- $emails : array<string|int, string> = null
-
Filter users by email(s). (optional)
- $scope : array<string|int, string> = null
-
Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags. (optional)
Tags
Return values
object —getNetworkSmUsersAsync()
Operation getNetworkSmUsersAsync
public
getNetworkSmUsersAsync(string $network_id[, array<string|int, string> $ids = null ][, array<string|int, string> $usernames = null ][, array<string|int, string> $emails = null ][, array<string|int, string> $scope = null ]) : PromiseInterface
List the owners in an SM network with various specified fields and filters
Parameters
- $network_id : string
-
(required)
- $ids : array<string|int, string> = null
-
Filter users by id(s). (optional)
- $usernames : array<string|int, string> = null
-
Filter users by username(s). (optional)
- $emails : array<string|int, string> = null
-
Filter users by email(s). (optional)
- $scope : array<string|int, string> = null
-
Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags. (optional)
Tags
Return values
PromiseInterface —getNetworkSmUsersAsyncWithHttpInfo()
Operation getNetworkSmUsersAsyncWithHttpInfo
public
getNetworkSmUsersAsyncWithHttpInfo(string $network_id[, array<string|int, string> $ids = null ][, array<string|int, string> $usernames = null ][, array<string|int, string> $emails = null ][, array<string|int, string> $scope = null ]) : PromiseInterface
List the owners in an SM network with various specified fields and filters
Parameters
- $network_id : string
-
(required)
- $ids : array<string|int, string> = null
-
Filter users by id(s). (optional)
- $usernames : array<string|int, string> = null
-
Filter users by username(s). (optional)
- $emails : array<string|int, string> = null
-
Filter users by email(s). (optional)
- $scope : array<string|int, string> = null
-
Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags. (optional)
Tags
Return values
PromiseInterface —getNetworkSmUserSoftwares()
Operation getNetworkSmUserSoftwares
public
getNetworkSmUserSoftwares(string $network_id, string $user_id) : object
Get a list of softwares associated with a user
Parameters
- $network_id : string
-
network_id (required)
- $user_id : string
-
user_id (required)
Tags
Return values
object —getNetworkSmUserSoftwaresAsync()
Operation getNetworkSmUserSoftwaresAsync
public
getNetworkSmUserSoftwaresAsync(string $network_id, string $user_id) : PromiseInterface
Get a list of softwares associated with a user
Parameters
- $network_id : string
-
(required)
- $user_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkSmUserSoftwaresAsyncWithHttpInfo()
Operation getNetworkSmUserSoftwaresAsyncWithHttpInfo
public
getNetworkSmUserSoftwaresAsyncWithHttpInfo(string $network_id, string $user_id) : PromiseInterface
Get a list of softwares associated with a user
Parameters
- $network_id : string
-
(required)
- $user_id : string
-
(required)
Tags
Return values
PromiseInterface —getNetworkSmUserSoftwaresWithHttpInfo()
Operation getNetworkSmUserSoftwaresWithHttpInfo
public
getNetworkSmUserSoftwaresWithHttpInfo(string $network_id, string $user_id) : array<string|int, mixed>
Get a list of softwares associated with a user
Parameters
- $network_id : string
-
(required)
- $user_id : string
-
(required)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
getNetworkSmUsersWithHttpInfo()
Operation getNetworkSmUsersWithHttpInfo
public
getNetworkSmUsersWithHttpInfo(string $network_id[, array<string|int, string> $ids = null ][, array<string|int, string> $usernames = null ][, array<string|int, string> $emails = null ][, array<string|int, string> $scope = null ]) : array<string|int, mixed>
List the owners in an SM network with various specified fields and filters
Parameters
- $network_id : string
-
(required)
- $ids : array<string|int, string> = null
-
Filter users by id(s). (optional)
- $usernames : array<string|int, string> = null
-
Filter users by username(s). (optional)
- $emails : array<string|int, string> = null
-
Filter users by email(s). (optional)
- $scope : array<string|int, string> = null
-
Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags. (optional)
Tags
Return values
array<string|int, mixed> —of object, HTTP status code, HTTP response headers (array of strings)
createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options
getNetworkSmUserDeviceProfilesRequest()
Create request for operation 'getNetworkSmUserDeviceProfiles'
protected
getNetworkSmUserDeviceProfilesRequest(string $network_id, string $user_id) : Request
Parameters
- $network_id : string
-
(required)
- $user_id : string
-
(required)
Tags
Return values
Request —getNetworkSmUserSoftwaresRequest()
Create request for operation 'getNetworkSmUserSoftwares'
protected
getNetworkSmUserSoftwaresRequest(string $network_id, string $user_id) : Request
Parameters
- $network_id : string
-
(required)
- $user_id : string
-
(required)
Tags
Return values
Request —getNetworkSmUsersRequest()
Create request for operation 'getNetworkSmUsers'
protected
getNetworkSmUsersRequest(string $network_id[, array<string|int, string> $ids = null ][, array<string|int, string> $usernames = null ][, array<string|int, string> $emails = null ][, array<string|int, string> $scope = null ]) : Request
Parameters
- $network_id : string
-
(required)
- $ids : array<string|int, string> = null
-
Filter users by id(s). (optional)
- $usernames : array<string|int, string> = null
-
Filter users by username(s). (optional)
- $emails : array<string|int, string> = null
-
Filter users by email(s). (optional)
- $scope : array<string|int, string> = null
-
Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags. (optional)