> ## Documentation Index > Fetch the complete documentation index at: https://www.1password.dev/llms.txt > Use this file to discover all available pages before exploring further. # Replace a user > Replaces a user's attributes, following the SCIM 2.0 protocol (RFC 7644). Server-controlled fields (`id`, `meta`) are ignored on the request. EPM-managed and system-managed users, and users shared across multiple organizations, cannot be modified (403). **Required scope:** `Users.Write` (Write access to users with access to SaaS Manager) ## OpenAPI ````yaml /openapi/saas_manager_api.json put /api/scim/v2/Users/{userId} openapi: 3.0.4 info: title: SaaS Manager API description: >- By accessing or using 1Password Developer Tools, you agree to the [API and SDK Terms of Service](https://1password.com/legal/api-sdk-terms-of-service). --- The SaaS Manager public REST API lets you read and manage your applications, people, teams, contracts, devices, workflows and audit log programmatically. Resources are grouped by area (see the navigation). The conventions below apply across the whole API. ## Regions and base URL SaaS Manager is hosted in multiple regions. Pick the base URL for your tenant's region from the **Servers** dropdown — `https://app.trelica.com` (United States) or `https://eu.trelica.com` (Europe). Endpoint URLs throughout this reference use whichever server you select. ## Authentication Every request must send an `Authorization` header carrying an OAuth 2.0 access token, prefixed with `Bearer`: ``` Authorization: Bearer ``` Obtain a token using either the **Client Credentials** flow (machine-to-machine) or the **Authorization Code** flow (acting on behalf of a user). The scopes granted to your token determine which endpoints you may call — see [Scopes](#scopes). Access tokens expire. When a token is missing, invalid or expired you receive `401 Unauthorized`; inspect the `WWW-Authenticate` response header for detail, for example: ``` Bearer error="invalid_token", error_description="The token expired at '12/23/2020 10:27:15'" ``` If you used the Authorization Code flow with the `offline_access` scope, use your refresh token to obtain a new access token. A `403 Forbidden` means the token is valid but lacks the scope required by the endpoint. ## Dates and times Dates and date/times are sent and returned in [RFC 3339](https://tools.ietf.org/html/rfc3339) format (essentially ISO 8601), for example `2020-12-25` (midnight) or `2020-12-25T10:50:00Z`. Field names ending in `Dtm` carry a meaningful time component; field names ending in `Date` are date-only. ## Optional fields and null Responses omit fields that have no value — you will see the field absent rather than returned as `null`. When creating or replacing a resource (`PUT`), any field you omit is cleared. With `PATCH`, omitting a field leaves it unchanged, whereas sending it as `null` clears it. ## Pagination List endpoints are paginated and return at most 100 results by default. Request a different upper bound with the `limit` query parameter (maximum 1000) — you may receive fewer than requested. Request the next page with the `after` query parameter, passing the opaque cursor token that SaaS Manager supplies. The response's `next` field (and the `link` response header, `rel="next"`) contains the full URL for the next page: ```json { "next": "https://app.trelica.com/api/people/v1?after=&limit=100", "results": [ { /* ... */ } ] } ``` Keep requesting pages until no further results are returned. (User data exposed over SCIM uses the SCIM `startIndex`/`count` pagination scheme instead.) ## Filtering Many list endpoints accept a `filter` query parameter (URL-encoded) based on the [SCIM filtering specification](https://tools.ietf.org/html/rfc7644#section-3.4.2.2). A filter is one or more expressions — an attribute name, an operator, and an optional value — combined with `and`, `or`, `not`, and grouped with parentheses. Attribute names match the JSON returned and may use dot notation for nested attributes (e.g. `createdBy.email`). For an attribute that is an **array of objects**, put a sub-expression in brackets — the item matches when *any* element satisfies it: `teams[name eq "Developers"]` or `teams[id eq "5f8d0a1b2c3d4e5f60718293"]`. Values are strings (double-quoted), integers, dates (double-quoted, RFC 3339) or booleans. Some list endpoints also accept a free-text `q` parameter that searches the resource's displayable fields. Soft-deleted entities are excluded by default; include them with a filter that references `deleted` (e.g. `filter=deleted eq true`). | Operator | Meaning | Behaviour | |----------|---------|-----------| | `eq` | equal | Attribute value is identical to the operator value | | `ne` | not equal | Attribute value differs from the operator value | | `co` | contains | Attribute value contains the operator value text | | `sw` | starts with | Attribute value starts with the operator value text | | `ew` | ends with | Attribute value ends with the operator value text | | `pr` | present | Attribute has a non-empty / non-null value | | `gt` | greater than | Attribute value is greater than the operator value | | `ge` | greater than or equal | Attribute value is greater than or equal to the operator value | | `lt` | less than | Attribute value is less than the operator value | | `le` | less than or equal | Attribute value is less than or equal to the operator value | For `gt`/`ge`/`lt`/`le`, strings compare lexicographically, dates chronologically and numbers numerically. Each list endpoint documents the fields you can filter on. **Examples** | Filter | Result | |--------|--------| | `firstName sw "Jan"` | People whose first name starts with "Jan" | | `teams[name eq "Developers"]` | People in the team called Developers | | `not (leavingDate pr)` | People with no leaving date | | `lastModifiedDtm ge "2021-06-01"` | Records modified on or after 1 June 2021 | ## Errors A `400 Bad Request` indicates a problem with your request. The body is a problem-details object: `errors` maps each offending field to its messages, with `title`, `status`, a `type` URL, and an `extensions.traceId` for correlation: ```json { "errors": { "leavingDate": [ "Error converting value \"2020-40-40\" ..." ] }, "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "extensions": { "traceId": "00-91e4405b...-00" } } ``` You should not normally see `500 Internal Server Error`. If you do, the body is a generic message — please contact [saasmanager@1password.com](mailto:saasmanager@1password.com) with details of the request so we can investigate. ## Scopes Scopes define what an API app may do. Following security best practice, grant only the scopes you need. Each endpoint documents the scope(s) it requires. | Scope | Description | |-------|-------------| | `Apps.Read` | Read-only access to applications | | `Apps.Users.Read` | Read-only access to application accounts | | `Apps.Write` | Write access to applications | | `Assets.Read` | Read-only access to devices | | `Assets.Write` | Write access to devices | | `AuditLog.Read` | Read-only access to the audit log | | `Contracts.Read` | Read-only access to contracts | | `Contracts.Write` | Write access to contracts | | `People.Read` | Read-only access to people and teams | | `People.Write` | Write access to people and teams | | `Users.Read` | Read-only access to users with access to SaaS Manager | | `Users.Write` | Write access to users with access to SaaS Manager | | `Workflows.Read` | Read-only access to workflow definitions | | `Workflows.Runs.Read` | Read-only access to workflow runs | | `Workflows.Runs.Execute` | Execute workflow run actions | | `Workflows.Runs.ReadSecrets` | Read workflow run secrets | | `offline_access` | Issue a refresh token alongside the access token (Authorization Code flow) | contact: name: 1Password SaaS Manager Support email: saasmanager@1password.com version: v1 servers: - url: https://app.trelica.com description: United States - url: https://eu.trelica.com description: Europe security: [] tags: - name: Authentication description: >- Obtain an OAuth 2.0 access token. Use the Client Credentials flow for machine-to-machine access, or the Authorization Code flow to act on behalf of a user. - name: Applications description: >- List, search and manage applications, and list the accounts (users) on an application. - name: People description: List, search and manage the people in your organization. - name: Teams description: List and manage teams and the team hierarchy. - name: Contracts description: List and manage contracts. - name: Devices description: List and manage devices. The endpoints live under `/api/assets`. - name: Workflows description: >- List workflows (with their triggers and steps), list their runs, and fire signals on steps that are waiting for input. - name: Audit log description: >- Read your organization's audit log: a continuous, filterable stream of events. - name: SCIM description: >- Provision and manage users via the SCIM 2.0 protocol (RFC 7644). These endpoints follow the SCIM standard rather than the conventions used by the rest of the SaaS Manager API: they use `startIndex`/`count` paging, return a SCIM `ListResponse` envelope, identify schemas with `urn:` URIs, and exchange `application/scim+json`. The `ResourceTypes` endpoints support SCIM discovery (RFC 7643). paths: /api/scim/v2/Users/{userId}: put: tags: - SCIM summary: Replace a user description: >- Replaces a user's attributes, following the SCIM 2.0 protocol (RFC 7644). Server-controlled fields (`id`, `meta`) are ignored on the request. EPM-managed and system-managed users, and users shared across multiple organizations, cannot be modified (403). **Required scope:** `Users.Write` (Write access to users with access to SaaS Manager) parameters: - name: userId in: path description: The user's SCIM resource ID. required: true schema: type: string format: uuid requestBody: content: application/scim+json: schema: $ref: '#/components/schemas/ScimUser' example: schemas: - urn:ietf:params:scim:schemas:core:2.0:User userName: erika.mustermann@example.com name: formatted: Erika Mustermann familyName: Mustermann givenName: Erika displayName: Erika Mustermann title: Customer Success Manager preferredLanguage: en-GB locale: en-GB active: true emails: - primary: true type: work value: erika.mustermann@example.com roles: - value: Admin display: Admin primary: false id: 8089ac9b31841227d4aee4f0adecd81f meta: created: '2019-01-01T00:00:00Z' lastModified: '2024-12-06T14:58:12Z' resourceType: User required: true responses: '200': description: OK content: application/scim+json: schema: $ref: '#/components/schemas/ScimUser' example: schemas: - urn:ietf:params:scim:schemas:core:2.0:User userName: erika.mustermann@example.com name: formatted: Erika Mustermann familyName: Mustermann givenName: Erika displayName: Erika Mustermann title: Customer Success Manager preferredLanguage: en-GB locale: en-GB active: true emails: - primary: true type: work value: erika.mustermann@example.com roles: - value: Admin display: Admin primary: false id: 8089ac9b31841227d4aee4f0adecd81f meta: created: '2019-01-01T00:00:00Z' lastModified: '2024-12-06T14:58:12Z' resourceType: User '400': description: Bad Request content: application/scim+json: schema: $ref: '#/components/schemas/Error' example: type: about:blank title: One or more validation errors occurred. status: 400 detail: >- The request body failed validation. See errors for the offending fields. errors: email: - The email field is required. traceId: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01 '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/scim+json: schema: $ref: '#/components/schemas/Error' example: type: about:blank title: Not found. status: 404 detail: >- The requested resource does not exist or you do not have access to it. traceId: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01 '409': description: Conflict content: application/scim+json: schema: $ref: '#/components/schemas/Error' example: type: about:blank title: Conflict. status: 409 detail: >- The request conflicts with the current state (for example, the resource already exists). traceId: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01 security: - oauth2: - Users.Write components: schemas: ScimUser: type: object properties: schemas: type: array items: type: string userName: type: string description: >- Unique identifier for the user, typically their email address. Required; must belong to a domain verified for your organization. Immutable once set. nullable: true name: allOf: - $ref: '#/components/schemas/ScimName' description: The components of the user's name. nullable: true displayName: type: string description: >- The user's display name (derived from their name on output). Server-controlled. nullable: true readOnly: true nickName: type: string description: >- Accepted for SCIM compatibility but ignored (not stored or returned). nullable: true writeOnly: true profileUrl: type: string description: >- Accepted for SCIM compatibility but ignored (not stored or returned). nullable: true writeOnly: true title: type: string description: The user's job title, e.g. "Vice President". nullable: true userType: type: string description: >- Accepted for SCIM compatibility but ignored (not stored or returned). nullable: true writeOnly: true preferredLanguage: type: string description: >- The user's preferred language; mirrors locale on output. Set locale instead. nullable: true readOnly: true locale: type: string description: >- The user's default locale, e.g. "en-US", used for localizing currency, dates and numbers. nullable: true timezone: type: string description: >- The user's time zone in IANA ("Olson") format, e.g. "America/Los_Angeles". nullable: true active: type: boolean description: >- Whether the user is active. `false` suspends the user's SaaS Manager access. password: type: string description: >- A password for the user. Write-only; accepted for SCIM compatibility but never returned. nullable: true writeOnly: true emails: type: array items: $ref: '#/components/schemas/ScimEmail' description: Email addresses for the user. nullable: true phoneNumbers: type: array items: $ref: '#/components/schemas/ScimPhoneNumber' description: Phone numbers for the user. Only the first value is stored. nullable: true photos: type: array items: $ref: '#/components/schemas/ScimPhoto' description: >- Accepted for SCIM compatibility but ignored (not stored or returned). nullable: true writeOnly: true addresses: type: array items: $ref: '#/components/schemas/ScimAddress' description: >- A physical mailing address. Accepted for SCIM compatibility but ignored (not stored or returned). nullable: true writeOnly: true groups: type: array items: $ref: '#/components/schemas/ScimRef' description: >- Groups the user belongs to. Accepted for SCIM compatibility but ignored (not stored or returned). nullable: true writeOnly: true entitlements: type: array items: $ref: '#/components/schemas/ScimEntitlement' description: >- Entitlements held by the user. Accepted for SCIM compatibility but ignored (not stored or returned). nullable: true writeOnly: true roles: type: array items: $ref: '#/components/schemas/ScimRole' description: >- The SaaS Manager roles assigned to the user. Each role's `value` must match an existing role name. nullable: true x509Certificates: type: array items: $ref: '#/components/schemas/Scimx509Certificate' description: >- Accepted for SCIM compatibility but ignored (not stored or returned). nullable: true writeOnly: true id: type: string description: >- The service-provider-assigned SCIM resource ID. Server-controlled; ignored on requests. nullable: true readOnly: true externalId: type: string description: >- An identifier for the resource as defined by the provisioning client. nullable: true meta: allOf: - $ref: '#/components/schemas/ScimUserMetadata' description: >- Resource metadata (created/last-modified timestamps, resource type, location). Server-controlled; ignored on requests. nullable: true readOnly: true additionalProperties: false Error: type: object properties: type: type: string description: A URI reference identifying the problem type. title: type: string description: A short, human-readable summary of the problem. status: type: integer description: The HTTP status code. format: int32 detail: type: string description: >- A human-readable explanation specific to this occurrence of the problem. errors: type: object additionalProperties: type: array items: type: string description: Validation errors keyed by field name. Present on 400 responses. traceId: type: string description: >- A trace identifier for correlating the error with SaaS Manager support. additionalProperties: false description: An error response (RFC 7807 problem details). ScimName: type: object properties: formatted: type: string description: >- The full name formatted for display, e.g. "Ms. Barbara Jane Jensen, III". nullable: true familyName: type: string description: The family (last) name of the user. nullable: true givenName: type: string description: The given (first) name of the user. nullable: true middleName: type: string description: >- The middle name(s) of the user. Combined with the given name when stored. nullable: true honorificPrefix: type: string nullable: true honorificSuffix: type: string nullable: true additionalProperties: false ScimEmail: type: object properties: value: type: string nullable: true display: type: string nullable: true type: type: string nullable: true primary: type: boolean additionalProperties: false ScimPhoneNumber: type: object properties: primary: type: boolean type: type: string nullable: true value: type: string nullable: true additionalProperties: false ScimPhoto: type: object properties: type: type: string nullable: true value: type: string nullable: true additionalProperties: false ScimAddress: type: object properties: primary: type: boolean type: type: string nullable: true formatted: type: string nullable: true streetAddress: type: string nullable: true locality: type: string nullable: true region: type: string nullable: true postalCode: type: string nullable: true country: type: string nullable: true additionalProperties: false ScimRef: type: object properties: $ref: 675b9a99-4680-475b-87fe-6b568c3a1afb value: type: string nullable: true display: type: string nullable: true additionalProperties: false ScimEntitlement: type: object properties: value: type: string nullable: true display: type: string nullable: true type: type: string nullable: true primary: type: boolean additionalProperties: false ScimRole: type: object properties: value: type: string description: 'The role''s value: the name of an existing SaaS Manager role.' nullable: true display: type: string description: A human-readable name for the role, for display purposes. nullable: true type: type: string description: >- Accepted for SCIM compatibility but ignored (not stored or returned). nullable: true writeOnly: true primary: type: boolean description: >- Whether this is the primary role. The primary value `true` must appear at most once. additionalProperties: false Scimx509Certificate: type: object properties: value: type: string nullable: true display: type: string nullable: true type: type: string nullable: true primary: type: boolean additionalProperties: false ScimUserMetadata: type: object properties: created: type: string format: date-time nullable: true lastModified: type: string format: date-time nullable: true version: type: string nullable: true location: type: string nullable: true resourceType: type: string nullable: true additionalProperties: false securitySchemes: oauth2: type: oauth2 description: >- OAuth 2.0. Obtain an access token via the Client Credentials or Authorization Code flow, then send it as `Authorization: Bearer `. flows: clientCredentials: tokenUrl: https://app.trelica.com/connect/token scopes: Apps.Read: Read-only access to applications Apps.Users.Read: Read-only access to application accounts Apps.Write: Write access to applications Assets.Read: Read-only access to devices Assets.Write: Write access to devices AuditLog.Read: Read-only access to the audit log Contracts.Read: Read-only access to contracts Contracts.Write: Write access to contracts People.Read: Read-only access to people and teams People.Write: Write access to people and teams Users.Read: Read-only access to users with access to SaaS Manager Users.Write: Write access to users with access to SaaS Manager Workflows.Read: Read-only access to workflow definitions Workflows.Runs.Read: Read-only access to workflow runs Workflows.Runs.Execute: Execute workflow run actions Workflows.Runs.ReadSecrets: Read workflow run secrets offline_access: >- Issue a refresh token alongside the access token (Authorization Code flow) authorizationCode: authorizationUrl: https://app.trelica.com/connect/authorize tokenUrl: https://app.trelica.com/connect/token scopes: Apps.Read: Read-only access to applications Apps.Users.Read: Read-only access to application accounts Apps.Write: Write access to applications Assets.Read: Read-only access to devices Assets.Write: Write access to devices AuditLog.Read: Read-only access to the audit log Contracts.Read: Read-only access to contracts Contracts.Write: Write access to contracts People.Read: Read-only access to people and teams People.Write: Write access to people and teams Users.Read: Read-only access to users with access to SaaS Manager Users.Write: Write access to users with access to SaaS Manager Workflows.Read: Read-only access to workflow definitions Workflows.Runs.Read: Read-only access to workflow runs Workflows.Runs.Execute: Execute workflow run actions Workflows.Runs.ReadSecrets: Read workflow run secrets offline_access: >- Issue a refresh token alongside the access token (Authorization Code flow) ```` ## Related topics - [Create or replace a person](/api-reference/people/create-or-replace-a-person.md) - [Update a user](/api-reference/scim/update-a-user.md) - [Create or replace a device](/api-reference/devices/create-or-replace-a-device.md)