Skip to content

Replace a user

PUT
/scim/v2/Users/{id}
curl --request PUT \
--url https://beta-api.plune.ai/scim/v2/Users/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/scim+json' \
--data '{ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "externalId": "example", "userName": "example", "name": { "givenName": "example", "familyName": "example" }, "displayName": "example", "active": true, "emails": [ { "value": "example", "type": "example", "primary": true } ] }'

The kept attributes as sent. active: false takes the person out of the company and all its projects in one transaction - the next request of their session or API token there is refused - and keeps the link, the role and the history; the account, its sessions and its personal projects stay (ADR 0079 Р258 А), and a sign-in through SSO does not bring the person back. active: true brings them back with the role they had. The company owner is never switched off (400 mutability), nor the last owner of a project of the company. 300 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.

id
required
string

The SCIM id Plune gave the user.

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>
Example
[
"urn:ietf:params:scim:schemas:core:2.0:User"
]
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

The user

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

userName changed, the owner switched off (mutability), or the body is not one

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

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

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