Skip to content

Find the company’s users

GET
/scim/v2/Users
curl --request GET \
--url 'https://beta-api.plune.ai/scim/v2/Users?filter=userName%20eq%20%22ada%40acme.example%22&startIndex=1&count=200' \
--header 'Authorization: Bearer <token>'

The company of the token only, the switched-off ones too (Entra asks for them), oldest first. filter: eq clauses joined by and over userName (any case), externalId (case-exact) and emails[type eq "work"].value - what Okta and Entra send; anything else is 400 invalidFilter. startIndex is 1-based; count at most 200. 600 a minute a company. A company without Enterprise in active or grace is refused 403 enterprise_required; it loses nothing and nobody is switched off.

filter
string
Example
userName eq "ada@acme.example"
startIndex
integer
default: 1 >= 1
count
integer
default: 200 <= 200

The page

Media type application/scim+json
object
schemas
required
Array<string>
Allowed values: urn:ietf:params:scim:api:messages:2.0:ListResponse
totalResults
required
integer
startIndex
required
integer
itemsPerPage
required
integer
Resources
required
Array<object>
object
Example
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
]
}

A filter Plune does not answer (scimType: invalidFilter)

Media type application/scim+json

RFC 7644 §3.12. Never repeats the request, its token or a value it carried.

object
schemas
required
Array<string>
Allowed values: urn:ietf:params:scim:api:messages:2.0:Error
status
required
string
scimType
string
Allowed values: invalidFilter uniqueness mutability invalidSyntax invalidValue
detail
required
string
code

Plune’s word, on the 403 of a company without Enterprise.

string
Allowed values: enterprise_required
Example
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"status": "409",
"scimType": "invalidFilter",
"code": "enterprise_required"
}

No SCIM token

Media type application/scim+json

RFC 7644 §3.12. Never repeats the request, its token or a value it carried.

object
schemas
required
Array<string>
Allowed values: urn:ietf:params:scim:api:messages:2.0:Error
status
required
string
scimType
string
Allowed values: invalidFilter uniqueness mutability invalidSyntax invalidValue
detail
required
string
code

Plune’s word, on the 403 of a company without Enterprise.

string
Allowed values: enterprise_required
Example
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"status": "409",
"scimType": "invalidFilter",
"code": "enterprise_required"
}

No Enterprise (code: enterprise_required)

Media type application/scim+json

RFC 7644 §3.12. Never repeats the request, its token or a value it carried.

object
schemas
required
Array<string>
Allowed values: urn:ietf:params:scim:api:messages:2.0:Error
status
required
string
scimType
string
Allowed values: invalidFilter uniqueness mutability invalidSyntax invalidValue
detail
required
string
code

Plune’s word, on the 403 of a company without Enterprise.

string
Allowed values: enterprise_required
Example
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"status": "409",
"scimType": "invalidFilter",
"code": "enterprise_required"
}

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}
Retry-After
integer

Seconds until the window rolls over