User

HTTP methods with User resource(s)

Get Service Provider Configuration

get

/scim/v2/{accountRegNo}/ServiceProviderConfig

This endpoint returns the Service Provider Configuration, which contains the service provider's supported features.

Authorizations

AuthorizationstringRequired

Responses

200

Success - Service Provider Configuration found

application/scim+json

500

Internal server error - Implementers provide a descriptive debugging advice

application/scim+json

get/scim/v2/{accountRegNo}/ServiceProviderConfig

GET /scim/v2/{accountRegNo}/ServiceProviderConfig HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "authenticationSchemes": [],
  "filter": {
    "supported": false
  },
  "patch": {
    "supported": false
  },
  "sort": {
    "supported": false
  },
  "bulk": {
    "supported": false
  },
  "etag": {
    "supported": false
  },
  "changePassword": {
    "supported": true
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"
  ]
}

Get filtered or all Users

get

/scim/v2/{accountRegNo}/Users

This endpoint returns all or filtered Users. Utilize the query parameters to configure filtering, sorting, pagination and in-/excluded attribues.

Authorizations

AuthorizationstringRequired

Query parameters

sortOrderstring · enumOptional

The order in which the "sortBy" parameter is applied. Allowed values are "ascending" and "descending". If a value for "sortBy" is provided and no "sortOrder" is specified, "sortOrder" SHALL default to ascending. String type attributes are case insensitive by default, unless the attribute type is defined as a case-exact string. "sortOrder" MUST sort according to the attribute type; i.e., for case-insensitive attributes, sort the result using case-insensitive Unicode alphabetic sort order with no specific locale implied, and for case-exact attribute types, sort the result using case-sensitive Unicode alphabetic sort order.

Default: ascendingExample: descendingPossible values:

cursorintegerOptional

The 1-based index of the first query result. A value less than 1 SHALL be interpreted as 1.

Default: 1Example: 2313

countintegerOptional

Non-negative integer. Specifies the desired maximum number of query results per page, e.g., 10. A negative value SHALL be interpreted as "0". A value of "0" indicates that no resource results are to be returned except for "totalResults".

Default: 1000Example: 10

Responses

200

Success - list of all Users

application/scim+json

The ListResponse specifies control attribute for big collections returned. The attributes thus cover information about the pagination. The assigned Resource object contains the queried resources.

totalResultsinteger · int32Required

Non-negative integer. Specifies the total number of results matching the client query, e.g., 1000.

Example: 1000

startIndexinteger · int32Required

The 1-based index of the first result in the current set of query results, e.g., 1.

Example: 1

itemsPerPageinteger · int32Required

Non-negative integer. Specifies the number of query results returned in a query response page, e.g., 10.

Example: 10

400

Bad request - See scimType for further information

application/scim+json

401

Unauthorized - Authentication failed try again with a valid authentication

application/scim+json

403

Forbidden - Authentication was successful but the user is not authorized

application/scim+json

404

Not found - No resource with provided Id

application/scim+json

500

Internal server error - Implementers provide a descriptive debugging advice

application/scim+json

get/scim/v2/{accountRegNo}/Users

GET /scim/v2/{accountRegNo}/Users HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "Resource": [
    {
      "schemas": [
        "text"
      ],
      "id": "name@gmail.com"
    }
  ],
  "totalResults": 1000,
  "startIndex": 1,
  "itemsPerPage": 10
}

Create new user resource

post

/scim/v2/{accountRegNo}/Users

Creates a new User. Some attributes might be immutable, thus make sure these are set correctly for creation. Unset required attributes might lead to assertions or insertion of default values. Readonly attributes are ignored. The query parameters attribues and excludedAttributes refer to the response upon success. The id attributes is set by the Service Provider to ensure uniqueness.

Authorizations

AuthorizationstringRequired

Body

SCIM provides a resource type for "User" resources. The core schema for "User" is identified using the following schema URI "urn:ietf:params:scim:schemas:core:2.0:User". The following attributes are defined in addition to the core schema attributes

schemasstring[]Required

The schema(s) involved in the SCIM resource.

idstring · emailRequired

A unique identifier for a SCIM resource as defined by the service provider. Each representation of the resource MUST include a non-empty "id" value. This identifier MUST be unique across the SCIM service provider's entire set of resources. It MUST be a stable, non-reassignable identifier that does not change when the same resource is returned in subsequent requests. The value of the "id" attribute is always issued by the service provider and MUST NOT be specified by the client. The string "bulkId" is a reserved keyword and MUST NOT be used within any unique identifier value. The attribute characteristics are "caseExact" as "true", a mutability of "readOnly", and a "returned" characteristic of "always". See Section 9 RFC7643 for additional considerations regarding privacy.

userNamestringRequired

A service provider's unique identifier for the user, typically used by the user to directly authenticate to the service provider. Often displayed to the user as their unique identifier within the system (as opposed to "id" or "externalId", which are generally opaque and not user-friendly identifiers). Each User MUST include a non-empty userName value. This identifier MUST be unique across the service provider's entire set of Users. This attribute is REQUIRED and is case insensitive.

Example: user@company.com

titlestringOptional

The user's title, such as "IT Architect".

Example: IT Architect

userTypestring · enumOptional

Used to identify the permission in Qvalia account.

Pattern: ^[viewer|user|admin]$Possible values:

preferredLanguagestring · enumOptional

Indicates the user's preferred written or spoken languages and is generally used for selecting a localized user interface. The value indicates the set of natural languages that are preferred. The format of the value is the same as the HTTP Accept-Language header field (not including "Accept-Language:") and is specified in Section 5.3.5 of [RFC7231]. The intent of this value is to enable cloud applications to perform matching of language tags [RFC4647] to the user's language preferences, regardless of what may be indicated by a user agent (which might be shared), or in an interaction that does not involve a user (such as in a delegated OAuth 2.0 [RFC6749] style interaction) where normal HTTP Accept-Language header negotiation cannot take place.

Possible values:

activebooleanOptional

A Boolean value indicating the user's administrative status. The definitive meaning of this attribute is determined by the service provider. As a typical example, a value of true implies that the user is able to log in, while a value of false implies that the user's account has been suspended.

Example: true

passwordstring · passwordWrite-onlyOptional

This attribute is intended to be used as a means to set, replace, or compare (i.e., filter for equality) a password. The cleartext value or the hashed value of a password SHALL NOT be returnable by a service provider. If a service provider holds the value locally, the value SHOULD be hashed. When a password is set or changed by the client, the cleartext password SHOULD be processed by the service provider as follows

Prepare the cleartext value for international language comparison. See Section 7.8 of [RFC7644].
Validate the value against server password policy. Note, The definition and enforcement of password policy are beyond the scope of this document.
Ensure that the value is encrypted (e.g., hashed). See Section 9.2 of [RFC7643] for acceptable hashing and encryption handling when storing or persisting for provisioning workflow reasons.

A service provider that immediately passes the cleartext value on to another system or programming interface MUST pass the value directly over a secured connection (e.g., Transport Layer Security (TLS)). If the value needs to be temporarily persisted for a period of time (e.g., because of a workflow) before provisioning, then the value MUST be protected by some method, such as encryption. Testing for an equality match MAY be supported if there is an existing stored hashed value. When testing for equality, the service provider

Prepares the filter value for international language comparison. See Section 7.8 of [RFC7644].
Generates the salted hash of the filter value and tests for a match with the locally held value.

The mutability of the password attribute is \"writeOnly\", indicating that the value MUST NOT be returned by a service provider in any form (the attribute characteristic \"returned\" is \"never\").

Responses

201

Success - User created

application/scim+json

schemasstring[]Required

The schema(s) involved in the SCIM resource.

idstring · emailRequired

userNamestringRequired

Example: user@company.com

titlestringOptional

The user's title, such as "IT Architect".

Example: IT Architect

userTypestring · enumOptional

Used to identify the permission in Qvalia account.

Pattern: ^[viewer|user|admin]$Possible values:

preferredLanguagestring · enumOptional

Possible values:

activebooleanOptional

Example: true

passwordstring · passwordWrite-onlyOptional

Prepare the cleartext value for international language comparison. See Section 7.8 of [RFC7644].
Validate the value against server password policy. Note, The definition and enforcement of password policy are beyond the scope of this document.
Ensure that the value is encrypted (e.g., hashed). See Section 9.2 of [RFC7643] for acceptable hashing and encryption handling when storing or persisting for provisioning workflow reasons.

Prepares the filter value for international language comparison. See Section 7.8 of [RFC7644].
Generates the salted hash of the filter value and tests for a match with the locally held value.

The mutability of the password attribute is \"writeOnly\", indicating that the value MUST NOT be returned by a service provider in any form (the attribute characteristic \"returned\" is \"never\").

400

Bad request - See scimType for further information

application/scim+json

401

Unauthorized - Authentication failed try again with a valid authentication

application/scim+json

403

Forbidden - Authentication was successful but the user is not authorized

application/scim+json

404

Not found - No resource with provided Id

application/scim+json

409

Conflict - Outdated version number or refusal of Service Provider to create a duplicate

application/scim+json

500

Internal server error - Implementers provide a descriptive debugging advice

application/scim+json

post/scim/v2/{accountRegNo}/Users

POST /scim/v2/{accountRegNo}/Users HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Content-Type: application/scim+json
Accept: */*
Content-Length: 216

{
  "userName": "user@company.com",
  "name": [],
  "title": "IT Architect",
  "userType": "viewer",
  "preferredLanguage": "en",
  "active": true,
  "password": "password",
  "emails": [],
  "phoneNumbers": [],
  "schemas": [
    "text"
  ],
  "id": "name@gmail.com"
}

{
  "userName": "user@company.com",
  "name": [],
  "title": "IT Architect",
  "userType": "viewer",
  "preferredLanguage": "en",
  "active": true,
  "emails": [],
  "phoneNumbers": [],
  "schemas": [
    "text"
  ],
  "id": "name@gmail.com"
}

Get user by Id

get

/scim/v2/{accountRegNo}/Users/{id}

Finds a single User by its id attribute. Returned attributes might be specified or restricted with the query parameter attributes or excludedAttributes. Some attributes might not be readable according their schema definition.

Authorizations

AuthorizationstringRequired

Path parameters

idstring · uuidRequired

Reference to the resouce which should be queried

Query parameters

attributesstringOptional

A multi-valued list of strings indicating the names of resource attributes to return in the response, overriding the set of attributes that would be returned by default. Attribute names MUST be in standard attribute notation (see Section 3.10 of RFC7644) form. See Section 3.9 of RFC7644 for additional retrieval query parameters.

Example: id,groups,roles,accounts

excludedAttributesstringOptional

A multi-valued list of strings indicating the names of resource attributes to be removed from the default set of attributes to return. This parameter SHALL have no effect on attributes whose schema "returned" setting is "always" (see Sections 2.2 and 7 of RFC7644). Attribute names MUST be in standard attribute notation (Section 3.10 of RFC7644) form. See Section 3.9 of RFC7644 for additional retrieval query parameters.

Example: schema,meta

Responses

200

Success - User found

application/scim+json

schemasstring[]Required

The schema(s) involved in the SCIM resource.

idstring · emailRequired

userNamestringRequired

Example: user@company.com

titlestringOptional

The user's title, such as "IT Architect".

Example: IT Architect

userTypestring · enumOptional

Used to identify the permission in Qvalia account.

Pattern: ^[viewer|user|admin]$Possible values:

preferredLanguagestring · enumOptional

Possible values:

activebooleanOptional

Example: true

passwordstring · passwordWrite-onlyOptional

Prepare the cleartext value for international language comparison. See Section 7.8 of [RFC7644].
Validate the value against server password policy. Note, The definition and enforcement of password policy are beyond the scope of this document.
Ensure that the value is encrypted (e.g., hashed). See Section 9.2 of [RFC7643] for acceptable hashing and encryption handling when storing or persisting for provisioning workflow reasons.

Prepares the filter value for international language comparison. See Section 7.8 of [RFC7644].
Generates the salted hash of the filter value and tests for a match with the locally held value.

The mutability of the password attribute is \"writeOnly\", indicating that the value MUST NOT be returned by a service provider in any form (the attribute characteristic \"returned\" is \"never\").

400

Bad request - See scimType for further information

application/scim+json

401

Unauthorized - Authentication failed try again with a valid authentication

application/scim+json

403

Forbidden - Authentication was successful but the user is not authorized

application/scim+json

404

Not found - No resource with provided Id

application/scim+json

500

Internal server error - Implementers provide a descriptive debugging advice

application/scim+json

get/scim/v2/{accountRegNo}/Users/{id}

GET /scim/v2/{accountRegNo}/Users/{id} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "userName": "user@company.com",
  "name": [],
  "title": "IT Architect",
  "userType": "viewer",
  "preferredLanguage": "en",
  "active": true,
  "emails": [],
  "phoneNumbers": [],
  "schemas": [
    "text"
  ],
  "id": "name@gmail.com"
}

Update user by Id

put

/scim/v2/{accountRegNo}/Users/{id}

Updates a present User. Unset required attributes might lead to assertions or insertion of default values. Readonly attributes are ignored. The query parameters attribues and excludedAttributes refer to the response upon success.

Authorizations

AuthorizationstringRequired

Path parameters

idstring · uuidRequired

Reference to the resouce which requires an update

Query parameters

attributesstringOptional

Example: id,groups,roles,accounts

excludedAttributesstringOptional

Example: schema,meta

Body

schemasstring[]Required

The schema(s) involved in the SCIM resource.

idstring · emailRequired

userNamestringRequired

Example: user@company.com

titlestringOptional

The user's title, such as "IT Architect".

Example: IT Architect

userTypestring · enumOptional

Used to identify the permission in Qvalia account.

Pattern: ^[viewer|user|admin]$Possible values:

preferredLanguagestring · enumOptional

Possible values:

activebooleanOptional

Example: true

passwordstring · passwordWrite-onlyOptional

Prepare the cleartext value for international language comparison. See Section 7.8 of [RFC7644].
Validate the value against server password policy. Note, The definition and enforcement of password policy are beyond the scope of this document.
Ensure that the value is encrypted (e.g., hashed). See Section 9.2 of [RFC7643] for acceptable hashing and encryption handling when storing or persisting for provisioning workflow reasons.

Prepares the filter value for international language comparison. See Section 7.8 of [RFC7644].
Generates the salted hash of the filter value and tests for a match with the locally held value.

The mutability of the password attribute is \"writeOnly\", indicating that the value MUST NOT be returned by a service provider in any form (the attribute characteristic \"returned\" is \"never\").

Responses

200

Success - User updated

application/scim+json

schemasstring[]Required

The schema(s) involved in the SCIM resource.

idstring · emailRequired

userNamestringRequired

Example: user@company.com

titlestringOptional

The user's title, such as "IT Architect".

Example: IT Architect

userTypestring · enumOptional

Used to identify the permission in Qvalia account.

Pattern: ^[viewer|user|admin]$Possible values:

preferredLanguagestring · enumOptional

Possible values:

activebooleanOptional

Example: true

passwordstring · passwordWrite-onlyOptional

Prepare the cleartext value for international language comparison. See Section 7.8 of [RFC7644].
Validate the value against server password policy. Note, The definition and enforcement of password policy are beyond the scope of this document.
Ensure that the value is encrypted (e.g., hashed). See Section 9.2 of [RFC7643] for acceptable hashing and encryption handling when storing or persisting for provisioning workflow reasons.

Prepares the filter value for international language comparison. See Section 7.8 of [RFC7644].
Generates the salted hash of the filter value and tests for a match with the locally held value.

The mutability of the password attribute is \"writeOnly\", indicating that the value MUST NOT be returned by a service provider in any form (the attribute characteristic \"returned\" is \"never\").

400

Bad request - See scimType for further information

application/scim+json

401

Unauthorized - Authentication failed try again with a valid authentication

application/scim+json

403

Forbidden - Authentication was successful but the user is not authorized

application/scim+json

404

Not found - No resource with provided Id

application/scim+json

409

Conflict - Outdated version number or refusal of Service Provider to create a duplicate

application/scim+json

500

Internal server error - Implementers provide a descriptive debugging advice

application/scim+json

put/scim/v2/{accountRegNo}/Users/{id}

PUT /scim/v2/{accountRegNo}/Users/{id} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Content-Type: application/scim+json
Accept: */*
Content-Length: 216

{
  "userName": "user@company.com",
  "name": [],
  "title": "IT Architect",
  "userType": "viewer",
  "preferredLanguage": "en",
  "active": true,
  "password": "password",
  "emails": [],
  "phoneNumbers": [],
  "schemas": [
    "text"
  ],
  "id": "name@gmail.com"
}

{
  "userName": "user@company.com",
  "name": [],
  "title": "IT Architect",
  "userType": "viewer",
  "preferredLanguage": "en",
  "active": true,
  "emails": [],
  "phoneNumbers": [],
  "schemas": [
    "text"
  ],
  "id": "name@gmail.com"
}

Delete user by Id

delete

/scim/v2/{accountRegNo}/Users/{id}

Deletes a present User. For subsequent requests on that resource and after successful deletion, a HTTP status code 404 is returned.

Authorizations

AuthorizationstringRequired

Path parameters

idstring · uuidRequired

Reference to the resouce which should be deleted

Responses

204

Success - User deleted

No content

400

Bad request - See scimType for further information

application/scim+json

401

Unauthorized - Authentication failed try again with a valid authentication

application/scim+json

403

Forbidden - Authentication was successful but the user is not authorized

application/scim+json

404

Not found - No resource with provided Id

application/scim+json

409

Conflict - Outdated version number or refusal of Service Provider to create a duplicate

application/scim+json

412

Precondition failed - Failed to update. Resource has changed on the server.

application/scim+json

500

Internal server error - Implementers provide a descriptive debugging advice

application/scim+json

delete/scim/v2/{accountRegNo}/Users/{id}

DELETE /scim/v2/{accountRegNo}/Users/{id} HTTP/1.1
Host: api-qa.qvalia.com
Authorization: YOUR_API_KEY
Accept: */*

No content

PreviousSCIM NextModels

Last updated 14 days ago

Was this helpful?