Skip to content
NimlesNimlesNimles Docs

List users

GET
/api/tenant/{tenantId}/Users
curl --request GET \
  --url https://api.nimles.com/identity/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Users \
  --header 'Authorization: Bearer <token>'

Gets a list of users based on the provided filters. Results are restricted to the users the caller has access to based on their role assignments (tenant → resource-group hierarchy).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
tenantId
required
string format: uuid

Your tenant id.

Query Parameters

Section titled “Query Parameters”
onlyCurrentUser
boolean

True to return only the current user, false to return all users.

username
string

The username to filter users by.

verificationCode
string

The verification code to filter users by.

newPasswordCode
string

The new password code to filter users by.

email
string

One of the user’s email addresses, compared without regard to case.

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
fields
object
key
additional properties
string
data
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
relations
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
name
string
nullable
entityId
required
string format: uuid
entityType
required
string
>= 1 characters
relationType
required
string
>= 1 characters
tenantId
string format: uuid
nullable
resourceGroupId
string format: uuid
nullable
creatorId
string format: uuid
nullable
createdDate
string format: date-time
nullable
version
integer format: int32
nullable
lastModified
string format: date-time
nullable
picture
string format: uuid
nullable
username
required
string
>= 1 characters
firstName
string
nullable
lastName
string
nullable
emails
Array<object>
nullable
object
address
required
string
nullable
isPrimary
boolean
isVerified
boolean
loginProviders
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
name
required
string
nullable
identifier
required
string
nullable
phoneNumber
string
nullable
userNumber
integer format: int32
nullable
password
string
nullable
hasTempPassword
boolean
role
string
nullable
hasPassword
boolean
nullable
address
object
coAddress
string
nullable
state
string
nullable
country
string
nullable
name
string
nullable
firstName
string
nullable
lastName
string
nullable
street
string
nullable
postalCode
string
nullable
city
string
nullable
referrer
object
name
required
string
>= 1 characters
resourceId
required
string format: uuid
tenantId
required
string format: uuid
type
string
nullable
referrerId
string format: uuid
nullable
referrerTenantId
string format: uuid
nullable
referrerType
string
nullable
claims
Array<object>
nullable
object
claimType
required
string
nullable
claimValue
required
string
nullable

Example generated

{
  "data": [
    {
      "fields": {
        "additionalProperty": {
          "value": "example",
          "valueType": "example"
        }
      },
      "accessibility": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "relations": [
        {
          "fields": {
            "additionalProperty": {
              "value": "example",
              "valueType": "example"
            }
          },
          "accessibility": "example",
          "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "name": "example",
          "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "entityType": "example",
          "relationType": "example"
        }
      ],
      "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "createdDate": "2026-04-15T12:00:00Z",
      "version": 1,
      "lastModified": "2026-04-15T12:00:00Z",
      "picture": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "username": "example",
      "firstName": "example",
      "lastName": "example",
      "emails": [
        {
          "address": "example",
          "isPrimary": true,
          "isVerified": true
        }
      ],
      "loginProviders": [
        {
          "fields": {
            "additionalProperty": {
              "value": "example",
              "valueType": "example"
            }
          },
          "accessibility": "example",
          "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "name": "example",
          "identifier": "example"
        }
      ],
      "phoneNumber": "example",
      "userNumber": 1,
      "password": "example",
      "hasTempPassword": true,
      "role": "example",
      "hasPassword": true,
      "address": {
        "coAddress": "example",
        "state": "example",
        "country": "example",
        "name": "example",
        "firstName": "example",
        "lastName": "example",
        "street": "example",
        "postalCode": "example",
        "city": "example"
      },
      "referrer": {
        "name": "example",
        "resourceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "type": "example"
      },
      "referrerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "referrerTenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "referrerType": "example",
      "claims": [
        {
          "claimType": "example",
          "claimValue": "example"
        }
      ]
    }
  ]
}

401

Section titled “401”

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Section titled “403”

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}