Contents

GetVppUsersRequest

The request for the users’ details service.

Declaration

object GetVppUsersRequest

Properties

NameTypeDescription
batchTokenstring

A token that signifies which batch is being returned. A batchToken value is generated by the server and can be several kilobytes in size.

For an initial request that doesn’t include batchToken or sinceModifiedToken, a batchToken value is returned if the number of results exceeds a server-controlled limit. Subsequent requests must include batchToken. As long as additional batches remain, the server returns a new batchToken value in its response.

See Batched Responses for more information.

includeRetiredint32

If true, returns retired users in the results.

includeRetiredOnlyboolean

If true, returns only retired users in the results.

overrideIndexint32

A value from 1 to the totalBatchCount value that specifies the batch of results to return. For requests with a value equal to the totalBatchCount value, the sinceModifiedToken value is returned.

sinceModifiedTokenstring

A token that marks a place in time. After all records have been returned for a request, the server includes a sinceModifiedToken value in the response. Use it in subsequent requests to get licenses that have been modified since the token was generated.

See About SinceModifiedToken for more information.

sToken Requiredstring

The authentication token. For more information, see Authentication.

Discussion

See Also

Request and Response