Provision a person into the company
const url = 'https://beta-api.plune.ai/scim/v2/Users';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/scim+json'}, body: '{ "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 } ] }'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://beta-api.plune.ai/scim/v2/Users \ --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 person is found or made by the address, as a magic link and SSO do it, and joins the company with the SSO defaultRole (member when the company has no SSO settings) - never manager or owner; a person already in the company keeps the role they have. The projects are joined as by anyone of the company. active: false on the create links the person switched off. A company log entry scim.user_created. 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.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”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
Example
[ "urn:ietf:params:scim:schemas:core:2.0:User"]Plune’s opaque id; the directory does not set it.
The directory’s own id, compared case-exact.
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.
object
With the names, it fills the account’s name only while it has none.
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.
object
object
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
Plune’s opaque id; the directory does not set it.
The directory’s own id, compared case-exact.
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.
object
With the names, it fills the account’s name only while it has none.
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.
object
object
Example
{ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ], "userName": "ada@acme.example", "externalId": "00u1a2b3c4", "name": { "givenName": "Ada", "familyName": "Lovelace" }, "displayName": "Ada Lovelace", "emails": [ { "primary": true, "value": "ada@acme.example", "type": "work" } ], "active": true, "password": "sent by Okta and stored nowhere"}Responses
Section titled “ Responses ”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
Plune’s opaque id; the directory does not set it.
The directory’s own id, compared case-exact.
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.
object
With the names, it fills the account’s name only while it has none.
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.
object
object
Example
{ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User" ]}userName is not an address on a verified domain of THIS company (invalidValue), the account of the address is in the Bin, or the body is not one (invalidSyntax, invalidValue)
RFC 7644 §3.12. Never repeats the request, its token or a value it carried.
object
Plune’s word, on the 403 of a company without Enterprise.
Example
{ "schemas": [ "urn:ietf:params:scim:api:messages:2.0:Error" ], "status": "409", "scimType": "invalidFilter", "code": "enterprise_required"}No SCIM token
RFC 7644 §3.12. Never repeats the request, its token or a value it carried.
object
Plune’s word, on the 403 of a company without Enterprise.
Example
{ "schemas": [ "urn:ietf:params:scim:api:messages:2.0:Error" ], "status": "409", "scimType": "invalidFilter", "code": "enterprise_required"}No Enterprise
RFC 7644 §3.12. Never repeats the request, its token or a value it carried.
object
Plune’s word, on the 403 of a company without Enterprise.
Example
{ "schemas": [ "urn:ietf:params:scim:api:messages:2.0:Error" ], "status": "409", "scimType": "invalidFilter", "code": "enterprise_required"}A user with this userName exists in the company (scimType: uniqueness)
RFC 7644 §3.12. Never repeats the request, its token or a value it carried.
object
Plune’s word, on the 403 of a company without Enterprise.
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.
object
Example generated
{ "error": "example"}Headers
Section titled “Headers ”Seconds until the window rolls over