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

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": "[email protected]"
    }
  ],
  "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

Responses

201

Success - User created

application/scim+json

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": "[email protected]",
  "name": [],
  "title": "IT Architect",
  "userType": "viewer",
  "preferredLanguage": "en",
  "active": true,
  "password": "password",
  "emails": [],
  "phoneNumbers": [],
  "schemas": [
    "text"
  ],
  "id": "[email protected]"
}

{
  "userName": "[email protected]",
  "name": [],
  "title": "IT Architect",
  "userType": "viewer",
  "preferredLanguage": "en",
  "active": true,
  "emails": [],
  "phoneNumbers": [],
  "schemas": [
    "text"
  ],
  "id": "[email protected]"
}

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

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": "[email protected]",
  "name": [],
  "title": "IT Architect",
  "userType": "viewer",
  "preferredLanguage": "en",
  "active": true,
  "emails": [],
  "phoneNumbers": [],
  "schemas": [
    "text"
  ],
  "id": "[email protected]"
}

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

Responses

200

Success - User updated

application/scim+json

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": "[email protected]",
  "name": [],
  "title": "IT Architect",
  "userType": "viewer",
  "preferredLanguage": "en",
  "active": true,
  "password": "password",
  "emails": [],
  "phoneNumbers": [],
  "schemas": [
    "text"
  ],
  "id": "[email protected]"
}

{
  "userName": "[email protected]",
  "name": [],
  "title": "IT Architect",
  "userType": "viewer",
  "preferredLanguage": "en",
  "active": true,
  "emails": [],
  "phoneNumbers": [],
  "schemas": [
    "text"
  ],
  "id": "[email protected]"
}

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

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 23 days ago

Was this helpful?

hashtagGet Service Provider Configuration

hashtagGet filtered or all Users

hashtagCreate new user resource

hashtagGet user by Id

hashtagUpdate user by Id

hashtagDelete user by Id

Get Service Provider Configuration

Get filtered or all Users

Create new user resource

Get user by Id

Update user by Id

Delete user by Id