GuidesAPI DocsChangelogMy AppsSeismic Exchange
API Docs

Update a user with a full payload

put
https://api.seismic.com/scim/v2/Users/

Replaces a specific user by supplying the complete SCIM User resource payload. Use this endpoint when synchronizing full user state from identity providers. For example, send PUT /scim/v2/Users/76a01ceb-1cdf-4cfe-a02d-a20c702052c4 with the full user JSON including schemas, userName, and emails. Any missing fields in the request will be updated to null or result in a failed request. Custom properties are supported via urn:ietf:params:scim:schemas:extension:seismic:2.0:User; retrieve tenant-specific definitions from GET /scim/v2/Schemas.

Terminology

  • SCIM: System for Cross-domain Identity Management, a standard protocol for managing user identities across systems - GUID: Globally Unique Identifier format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) used for user IDs - HTTP: Hypertext Transfer Protocol; HTTP 404 indicates the userId was not found - RFC 7644: IETF standard for SCIM 2.0 full resource replacement (PUT) semantics
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique identifier (GUID - Globally Unique Identifier) of the user. Must be a valid UUID format (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). Obtain this value from GET /scim/v2/Users or user management operations.

Body Params

Complete SCIM User resource payload that replaces all existing user metadata.

boolean

Boolean indicating whether the user account is active and enabled in the system. When false, the user account is deactivated and cannot access the system.

addresses
array of objects

Physical mailing addresses associated with the user including formatted address, type classification, and primary designation.

addresses
emails
array of objects
required
length ≥ 1

Email addresses for the user. At least one work email is required when replacing the full user resource.

emails*

Email addresses for the User. The value SHOULD be canonicalized according to RFC 5321. At least one work email is required.

string
enum

A label indicating the attribute's function, specifying the context or purpose of this email address. we only support the type "work" and we only support 1 email.

Allowed:
boolean

A boolean value indicating whether this email address is the primary email for the user. Only one email should be marked as primary.

string

Email address value in standard email format. Must be a valid email address according to RFC 5321 standards.

uuid

The unique identifier for the user resource as a GUID. Should match the userId path parameter when provided in the request body.

ims
array of objects

Instant messaging addresses associated with the user representing social platform connections such as LinkedIn or Twitter.

ims
name
object

The components of the user's full name, including given name and family name, used for display and identification purposes.

phoneNumbers
array of objects

Phone numbers associated with the user account including type classification and primary designation.

phoneNumbers
roles
array of objects

Roles assigned to the user representing organizational role classification within the system.

roles
string
length between 2 and 10

The user's preferred written or spoken language, typically represented as an ISO 639-1 language code.

schemas
array of strings
required
length ≥ 1

SCIM schema identifiers array indicating which schema extensions apply to this user resource.

schemas*
string
length ≥ 1

The user's time zone identifier such as Eastern Standard Time or an IANA time zone database name.

string
length between 1 and 200

The user's job title or professional designation within the organization.

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
object

Enterprise user extension attributes that provide additional organizational information about the user, following the SCIM 2.0 Enterprise User Schema extension specification.

urn:ietf:params:scim:schemas:extension:seismic:2.0:User
object

Seismic-specific user extension attributes container. Retrieve tenant-specific custom property definitions from GET /scim/v2/Schemas.

string
required
length ≥ 1

Unique username for the user used for login and authentication. Required when replacing the full user resource.

string
enum

User type classification within the Seismic platform determining access levels and feature availability.

Allowed:
Responses

Updated 5 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/scim+json

Updated 5 days ago