Get a list of all users

Prev Next

Get

/api/users

Security

HTTP

Type bearer

Query parameters

filter

string

searchText

string

query

string

type

string

Default"User"

includeTags

boolean

Defaultfalse

page

integer

Parameter to specify the page number of the records to retrieve

Default0

size

integerRequired

parameter to specify the number of records to retrieve per page

Default20

sort

string

parameter to specify the sort parameter and direction

Responses

200

Expand All

object

count

integer

page

integer

size

string

sort

string

filter

string

data

Array of object (UserBeanResponse)

object

userId

string

username

string

status

string

Valid values[ "inactive", "active" ]

lastName

string

firstName

string

created

string (date-time)

modified

string (date-time)

phone

string

mobile

string

type

string

Valid values[ "User", "ServiceIdentity" ]

externalId

string

name

string

userTags

Array of object (UserTag)

object

name

string

external

boolean

users

Array of object (User)

object

name

string

type

string

Valid values[ "User", "ServiceIdentity" ]

attributes

Array of object (CustomUserAttribute)

object

integer (int64)

attributeValue

string

attributeId

string

attributeName

string

external

boolean

description

string

created

string (date-time)

status

string

Valid values[ "inactive", "active" ]

userId

integer (int32)

tenant

object (Tenant)

type

string

billingAddress

string

businessContactNo

string

technicalContactNo

string

pricingTier

string

rootUserId

string

namespace

string

created

object (AuditStamp)

user

string

date

string (date-time)

action

string

status

string

tenantId

integer (int32)

companyName

string

modified

object (AuditStamp)

user

string

date

string (date-time)

action

string

verified

object (AuditStamp)

user

string

date

string (date-time)

action

string

tenantId

integer (int32)

string

userTags

Array of object (UserTag)

object Recursive

username

string

mobile

string

firstName

string

lastName

string

phone

string

modified

string (date-time)

passwordChars

Array of string

string

authnDirUsername

string

identityProvider

object (IdentityProvider)

idpType

string

integer (int32)

name

string

description

string

attributesMap

Array of object (AttributeMap)

Provider's identity attributes mapped to Britive service identity custom attributes.

object

Single identity provider attribute mapped to service identity custom attribute

idpAttr

string

userAttr

string

validationWindow

integer (int32)

The amount of time in seconds, after the token has been issued/signed, Britive will attempt to validate the unverified token. Outside this window, token validation will fail.

maxDuration

integer (int32)

The maximum number of hours the client can request the AWS token be valid.

createdBy

integer (int32)

modifiedBy

integer (int32)

attributesMap

object

property*

Array of object (CustomUserAttribute) additionalProperties

object

integer (int64)

attributeValue

string

attributeId

string

attributeName

string

externalId

string

adminRoles

Array of object (AdminRole)

object

name

string

adminRoleId

integer (int32)

authority

string

lastLogin

string (date-time)

canChangeOrResetPassword

boolean

description

string

userTagId

string

created

string (date-time)

status

string

Valid values[ "Inactive", "Active" ]

modified

string (date-time)

userCount

integer (int32)

identityProviderId

string

identityProvider

object (IdentityProvider)

idpType

string

integer (int32)

name

string

description

string

attributesMap

Array of object (AttributeMap)

Provider's identity attributes mapped to Britive service identity custom attributes.

object

Single identity provider attribute mapped to service identity custom attribute

idpAttr

string

userAttr

string

validationWindow

integer (int32)

The amount of time in seconds, after the token has been issued/signed, Britive will attempt to validate the unverified token. Outside this window, token validation will fail.

maxDuration

integer (int32)

The maximum number of hours the client can request the AWS token be valid.

membershipRule

boolean

lastLogin

string (date-time)

external

boolean

adminRoles

Array of object (AdminRole)

object

name

string

adminRoleId

integer (int32)

authority

string

canChangeOrResetPassword

boolean

identityProvider

object (IdentityProvider)

idpType

string

integer (int32)

name

string

description

string

attributesMap

Array of object (AttributeMap)

Provider's identity attributes mapped to Britive service identity custom attributes.

object

Single identity provider attribute mapped to service identity custom attribute

idpAttr

string

userAttr

string

validationWindow

integer (int32)

The amount of time in seconds, after the token has been issued/signed, Britive will attempt to validate the unverified token. Outside this window, token validation will fail.

maxDuration

integer (int32)

The maximum number of hours the client can request the AWS token be valid.

Was this article helpful?