GET all users.

GET

/api/scim/namespaces/system/v2/Users

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/scim/namespaces/system/v2/Users \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

GET all users.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Query Parameters

filter

string

Filter to be used for filtering objects.

count

string format: uint64

The number of entries after filter.

page

string format: uint64

Start offset.

excludedAttributes

Array<string>

Members”]” A multi-valued list of strings indicating the names of resource attributes to be removed from the default set of attributes to return.

Responses

200

A successful response.

Media typeapplication/json

ListUserResources

ListUserResources list all the user objects.

object

Resources

Resources

Resources representing all the user objects.

Required: YES.

Array<object>

User

User object representing the user created.

object

active

active

Active specifies if user is active or not.

boolean format: boolean

displayName

displayName

DisplayName for the user.

string

<= 1024 characters

emails

emails

Emails for the user whether primary or secondary.

Array<object>

Email

Email for user can be primary or secondary.

object

primary

primary

Primary boolean describing whether it is primary or not.

boolean format: boolean

type

type

Type of email describing whether it is work or personal.

string

<= 1024 characters

value

value

Value.

string

>= 3 characters <= 1024 characters

externalId

externalId

ExternalId specifies the ID for the user object in external system. Required: YES.

string

<= 1024 characters

groups

groups

Groups to which user is part of. Required: YES.

Array<object>

UserGroup

UserGroup.

object

display

display

Display for the user group name.

string

<= 1024 characters

id

id

ID of the group to which user belongs.

string

>= 1 <= 4094 <= 1024 characters

id

id

ID for user object. Required: YES.

string

>= 1 <= 4094 <= 1024 characters

meta

object

created

created

Create date. Required: YES.

string

<= 1024 characters

lastModified

lastModified

Last modification date and time. Required: YES.

string

<= 1024 characters

location

location

[x-required] location for resource.

string

>= 4 characters <= 1024 characters

resourceType

resourceType

Type of resource. Required: YES.

string

<= 1024 characters

version

version

Version for resource type. Required: YES.

string

>= 1 characters <= 1024 characters

name

object

familyName

familyName

Family name.

string

<= 1024 characters

formatted

formatted

Formatted name is detailed name of person.

string

<= 1024 characters

givenName

givenName

Given name of the person.

string

<= 1024 characters

honorificPrefix

honorificPrefix

Prefix for the name. Mr Ms. Etc.

string

<= 1024 characters

honorificSuffix

honorificSuffix

Suffix for the name like Jr Sr I II III etc.

string

<= 1024 characters

middleName

middleName

Middle name of the person.

string

<= 1024 characters

nickName

nickName

NickName for the user.

string

<= 1024 characters

roles

roles

Roles defined for the user. Required: YES.

Array<string>

schemas

schemas

Schemas for user object as per scim spec 2.0. Required: YES.

Array<string>

userName

userName

UserName for the user. Required: YES.

string

<= 1024 characters

userType

string

default: USER

Allowed values: USER SERVICE DEBUG

itemsPerPage

itemsPerPage

ItemsPerPage The number of resources returned in a list response page

Required: YES.

string format: uint64

<= 1024 characters

schemas

schemas

Schemas for listing the user.

Required: YES.

Array<string>

startIndex

startIndex

StartIndex The 1-based index of the first result in the current set of list results.

Required: YES.

string format: uint64

<= 1024 characters

totalResults

totalResults

TotalResults for the search criteria.

Required: YES.

string format: uint64

<= 1024 characters

Example

{
  "Resources": [
    {
      "userType": "USER"
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example