Skip to content

One user of the company

GET
/scim/v2/Users/{id}
curl --request GET \
--url https://beta-api.plune.ai/scim/v2/Users/example \
--header 'Authorization: Bearer <token>'

A switched-off user is answered too, with active: false (Entra asks for them); a deleted one, or one of another company, is a SCIM 404. A company without Enterprise in active or grace is refused 403 enterprise_required; it loses nothing and nobody is switched off.

id
required
string

The SCIM id Plune gave the user.

The user, switched off or not

Media type application/scim+json

A person of the company (RFC 7643 §4.1). Kept and answered: userName, active, externalId, name.givenName, name.familyName, displayName, emails (ADR 0079 Р256 А). Any other attribute - the Enterprise extension, title, the password Okta sends on a create - is accepted and read by nothing: not stored, not logged, not answered.

object
schemas
Array<string>
id

Plune’s opaque id; the directory does not set it.

string
externalId

The directory’s own id, compared case-exact.

string
<= 500 characters
userName
required

The address of the account, lower case; its domain must be a verified domain of the company (ADR 0054 §4). It does not change after the create.

string
name
object
givenName
string
<= 200 characters
familyName
string
<= 200 characters
displayName

With the names, it fills the account’s name only while it has none.

string
<= 200 characters
active

false takes the person out of the company and every project of it at once; true brings them back with the role they had. The text "True"/"False" is read too.

boolean
emails
Array<object>
<= 10 items
object
value
required
string
type
string
primary
boolean
meta
object
resourceType
string
created
string format: date-time
lastModified
string format: date-time
location
string
Example
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
]
}

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

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 such user in the company of the token (or deleted)

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"
}