Skip to content

Search provider directory users and enrich them with local link candidates.

GET
/api/workspace/admin/external-identity/directory/users
curl --request GET \
--url 'https://example.com/api/workspace/admin/external-identity/directory/users?Limit=50' \
--header 'Authorization: Bearer <token>'
Query
string
Cursor
string
Limit
integer format: int32
default: 50
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

OK

Media typeapplication/json

Paginated provider directory search enriched with Workspace state.

object
Users
Array<object>
nullable

Directory result enriched with local linking information.

object
ProviderUser

Provider directory user identified only by the stable issuer and subject pair. The provider update time is absent when the provider does not expose one.

object
Issuer
string
nullable
Subject
string
nullable
Status
integer format: int32
Allowed values: 1 2 3
Profile

Provider-owned profile metadata. It is never an authorization input.

object
Email
string
nullable
GivenName
string
nullable
FamilyName
string
nullable
DisplayName
string
nullable
Phone
string
nullable
ProviderUpdatedAtUtc
string format: date-time
nullable
CurrentLink

Installation-local link between one Moltaro user and one stable external identity.

object
Id
string
nullable
ProviderConnectionId
string
nullable
LocalUserId
string
nullable
Issuer
string
nullable
Subject
string
nullable
Status
integer format: int32
Allowed values: 1 2 3 4 5
Profile

Provider-owned profile metadata. It is never an authorization input.

object
Email
string
nullable
GivenName
string
nullable
FamilyName
string
nullable
DisplayName
string
nullable
Phone
string
nullable
CreatedAtUtc
string format: date-time
LastSynchronizedAtUtc
string format: date-time
nullable
ArchivedAtUtc
string format: date-time
nullable
EmailMatchedUser

Summary projection for a workspace user.

object
Id

User identifier.

string
nullable
UserName

Exact stored Unicode login name.

string
nullable
Email

Optional email address.

string
nullable
FirstName

First name.

string
nullable
LastName

Last name.

string
nullable
UserType
integer format: int32
Allowed values: 0 1 2
IsBlocked

Whether the user is blocked from signing in.

boolean
IsDeleted

Whether the user is soft deleted.

boolean
Avatar

Avatar presentation values for a workspace user.

object
Initials

Initials derived from the user name.

string
nullable
BackgroundColor

Hex color for the avatar background.

string
nullable
TextColor

Hex color for the avatar text.

string
nullable
Roles

Roles assigned to this user.

Array<object>
nullable

Summary of a workspace role.

object
Id

Role identifier.

string
nullable
Name

Role display name.

string
nullable
Description

Role description.

string
nullable
AutoAssign

Whether the role is auto-assigned to new users.

boolean
IsSystem

Whether the role is a protected system role.

boolean
UserCount

Number of users assigned to this role.

integer format: int32
PermissionCount

Number of permissions assigned to this role.

integer format: int32
Tags

Tag names assigned to the role.

Array<string>
nullable
ExtendedData

Non-secret integration metadata.

object
key
additional properties
string
HasLocalPassword

Whether local password authentication is available.

boolean
ExternalIdentity

Safe current external identity state attached to a local user projection.

object
LinkId
string
nullable
ProviderKind
integer format: int32
Allowed values: 1 2
ProviderDisplayName
string
nullable
Status
integer format: int32
Allowed values: 1 2 3 4 5
Profile

Provider-owned profile metadata. It is never an authorization input.

object
Email
string
nullable
GivenName
string
nullable
FamilyName
string
nullable
DisplayName
string
nullable
Phone
string
nullable
DiagnosticCode
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7 8 9 10 11 12
LastSynchronizedAtUtc
string format: date-time
nullable
EmailConfirmed

Whether the optional email address has been confirmed.

boolean
RowVersion

Opaque concurrency token.

string
nullable
ExtendedData

Non-secret integration metadata.

object
key
additional properties
string
DisplayName

Canonical display name.

string
nullable
WorkerAssociation

Current Work Schedule association projected into a user read model.

object
Worker

Field-safe reference to the Worker associated with a workspace user.

object
EntityDefinitionId
string
nullable
Id
string
nullable
Number
string
nullable
DisplayName
string
nullable
Availability
string
nullable
AssociationVersion
string
nullable
NamesManagedByWorker
boolean
CanRead
boolean
CanManage
boolean
HasAmbiguousEmailMatch
boolean
CanProvision
boolean
CanLink
boolean
NextCursor
string
nullable
RetrievedAtUtc
string format: date-time
Example
{
"Users": [
{
"ProviderUser": {
"Status": 1
},
"CurrentLink": {
"Status": 1
},
"EmailMatchedUser": {
"UserType": 0,
"ExternalIdentity": {
"ProviderKind": 1,
"Status": 1,
"DiagnosticCode": 0
}
}
}
]
}