SCIM 1.1

SCIM 1.1 Specifications

You can see the detailed SCIM 1.1 specification documents here.

SCIM 1.1 Endpoints

User Endpoint

/seam/resource/restv1/Users


getUser

GET /host/seam/resource/restv1/scim/v1/Users{rsid}

Returns a user on the basis of provided id as path parameter. The resource MUST be already registered with the mentioned id.

URL
http://gluu.org/host/seam/resource/restv1/scim/v1/Users{rsid}
Request
Parameters
  • Following are the details about parameters:
    Parameter Location Required Description Data Type
    rsid path TRUE Resource set description ID string
    Authorization header FALSE string
Response

Content Type: application/json, application/xml

Success
  • Status Code Reason Description
    200 Successful Operation Resource returned successfully
Errors
  • Status Code Reason Description
    400 BAD REQUEST Request cannot be parsed, is syntactically incorrect, or violates schema.
    401 UNAUTHORIZED Authorization header is invalid or missing.
    403 FORBIDDEN Operation is not permitted based on the supplied authorization.
    404 NOT FOUND Specified user does not exist.

Group Endpoint

/seam/resource/restv1/Groups


getGroup

GET /host/seam/resource/restv1/scim/v1/Groups{rsid}

Returns a group on the basis of the provided id as a path parameter. The group MUST be already registered with the mentioned id.

URL
http://gluu.org/host/seam/resource/restv1/scim/v1/Groups{rsid}
Request
Parameters
  • Following are the details about parameters:
    Parameter Location Required Description Data Type
    rsid path TRUE Resource set description ID. string
    Authorization header FALSE string
Response

Content Type: application/json, application/xml

Success
  • Status Code Reason Description
    200 Successful Operation Group returned successfully.
Errors
  • Status Code Reason Description
    400 Bad Request Request cannot be parsed, is syntactically incorrect, or violates schema.
    401 Unauthorized Authorization header is invalid or missing.
    403 Forbidden Operation is not permitted based on the supplied authorization.
    404 Not Found Specified user does not exist.

Bulk Operation Endpoint

/seam/resource/restv1/scim/v1/Bulk


Bulk Operation

SCIM Bulk Operation enables consumers to work with a potentially large collection (bulk) of Resource operations in a single request. A body of a bulk operation may contain a set of HTTP Resource operations using one of the API supported HTTP methods; i.e., POST, PUT, PATCH or DELETE. (see http://www.simplecloud.info/specs/draft-scim-api-01.html#bulk-resources for more details.)

Security

  • Authorization

Request

Content-Type: application/json, application/xml

Parameters
Name Located in Required Description Default Schema
Authorization header no - string
body body no BulkRequest - BulkRequest

Response

Content-Type: application/json, application/xml

Status Code Reason Response Model
200 successful operation BulkResponse

Definitions

BulkOperation

name type required description example
bulkId string optional -
version string optional -
method string optional -
path string optional -
location string optional -
data object optional -
status string optional -
response object optional -

BulkRequest

name type required description example
schemes array[string] optional -
failOnErrors integer (int32) optional -
operations array[BulkOperation] optional -

BulkResponse

name type required description example
schemes array[string] optional -
operations array[BulkOperation] optional -