The APIs can be classified into three categories:
User Management—Search, create, update, delete, disable, or change password for users.
Group Management—List group members, add and remove members from the group.
Bulk—Send a potentially large collection of resource operations in a single request.
The SCIM /Users resource endpoint is used for several user management operations.
HTTP Request Method |
POST |
URI |
https://hs-identity-api.oracleindustry.com/scim/v1/<tenant>/Users |
Request schema URI |
urn:scim:schemas:core:2.0:User |
Response schema URI |
urn:scim:schemas:core:2.0:User |
HTTP Response Codes |
The following response codes apply:
For more information, see Section 2.4, "Return Codes". |
Request
POST /scim/v1/mypharma/Users HTTP 1.1 Host: example.com Authorization: Basic Y3VzdG9tZXIuYWRtaW51c2VyOnBhc3N3b3Jk= Accept: application/json Content-Type: application/json;charset=UTF-8 Content-Length: ...
{ "schemas" : [ "urn:scim:schemas:core:2.0:User" ], "externalId" : "john.doe@customer.com", "userName" : "john.doe", "name" : { "familyName" : "Doe", "givenName" : "John" }, "emails" : [ { "value" : "john.doe@mypharma.com", "type" : "work" } ], "phoneNumbers" : [ { "value" : "555-555-5555", "type" : "work" } ], "password" : "S0M3P@ssw0rd" }
Response
HTTP/1.1 201 Created Content-Type: application/json Content-Length: ... Location https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/ Users/5a5dc886031d49088cc01f723daa1f4e
{ "schemas" : [ "urn:scim:schemas:core:2.0:User" ], "id" : "5a5dc886031d49088cc01f723daa1f4e", "externalId" : "john.doe@mypharma.com", "userName" : "JOHN.DOE", "name" : { "familyName" : "Doe", "givenName" : "John" }, "emails" : [ { "value" : "john.doe@mypharma.com", "type" : "work" } ], "phoneNumbers" : [ { "value" : "555-555-5555", "type" : "work" } ], "userType" : "LIVE", "active" : true, "meta" : { "created" : "2014-05-20T14:02:57Z ", "lastModified" : "2014-05-20T14:02:57Z ", "location": "https://hs-identity- api.oracleindustry.com/scim/v1/mypharma/Users/5a5dc886031d49088cc01f723daa1f4e", "resourceType": "User" } }
Replaces the user attributes with the attributes specified in the request content. If an attribute is not specified, the value of that attribute is replaced as null.
If a password is not specified, the existing password is not altered.
HTTP Request Method |
PUT |
URI |
https://hs-identity-api.oracleindustry.com/scim/v1/<tenant>/Users/{id} |
Request schema URI |
urn:scim:schemas:core:2.0:User |
Response schema URI |
urn:scim:schemas:core:2.0:User |
HTTP Response Codes |
The following response codes apply:
For more information, see Section 2.4, "Return Codes". |
Request
PUT /scim/v1/mypharma/Users/5a5dc886031d49088cc01f723daa1f4e HTTP 1.1 Host: example.com Authorization: Basic Y3VzdG9tZXIuYWRtaW51c2VyOnBhc3N3b3Jk= Accept: application/json Content-Type: application/json;charset=UTF-8 Content-Length: ...
{ "schemas" : [ "urn:scim:schemas:core:2.0:User" ], "externalId" : "john.doe@mypharma.com", "userName" : "john.doe", "name" : { "familyName" : "Doe", "givenName" : "John" }, "emails" : [ { "value" : "john.doe@mypharma.com", "type" : "work" } ] }
Response
HTTP/1.1 200 OK Content-Type: application/json Content-Length: ... Location https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/ Users/5a5dc886031d49088cc01f723daa1f4e
{ "schemas" : [ "urn:scim:schemas:core:2.0:User" ], "id" : "5a5dc886031d49088cc01f723daa1f4e", "externalId" : "john.doe@mypharma.com", "userName" : "JOHN.DOE", "name" : { "familyName" : "Doe", "givenName" : "John" }, "emails" : [ { "value" : "john.doe@mypharma.com", "type" : "work" } ], "userType" : "LIVE", "active" : true, "meta" : { "created" : "2014-05-20T14:02:57Z", "lastModified" : "2014-06-06T13:48:48Z", "location": "https://hs-identity- api.oracleindustry.com/scim/v1/mypharma/Users/5a5dc886031d49088cc01f723daa1f4e", "resourceType": "User" } }
Use HTTP PATCH when only a portion of the user attributes are required to be changed.
HTTP Request Method |
PATCH |
URI |
https://hs-identity-api.oracleindustry.com/scim/v1/<tenant>/Users/{id} |
Request schema URI |
JSON Patch format (Refer to SCIM specification) |
Response schema URI |
urn:scim:schemas:core:2.0:User |
HTTP Response Codes |
The following response codes apply:
For more information, see Section 2.4, "Return Codes". |
Request
PATCH /scim/v1/customer/Users/5a5dc886031d49088cc01f723daa1f4e HTTP 1.1 Host: example.com Authorization: Basic Y3VzdG9tZXIuYWRtaW51c2VyOnBhc3N3b3Jk= Accept: application/json Content-Type: application/json;charset=UTF-8 Content-Length: ...
{ "op":"replace", "path":"name", "value":{ "familyName":"Does", "givenName":"Johnathan" } }
Response
HTTP/1.1 200 OK Content-Type: application/json Content-Length: ... Location https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/ Users/5a5dc886031d49088cc01f723daa1f4e
{ "schemas" : [ "urn:scim:schemas:core:2.0:User" ], "id" : "5a5dc886031d49088cc01f723daa1f4e", "externalId" : "john.doe@mypharma.com", "userName" : "JOHN.DOE", "name" : { "familyName" : "Does", "givenName" : " Johnathan " }, "emails" : [ { "value" : "john.doe@mypharma.com", "type" : "work" } ], "phoneNumbers" : [ { "value" : "555-555-5555", "type" : "work" } ], "userType" : "LIVE", "active" : true, "meta" : { "created" : "2014-05-20T14:02:57Z", "lastModified" : "2014-06-06T13:48:48Z", "location": "https://hs-identity- api.oracleindustry.com/scim/v1/mypharma/Users/5a5dc886031d49088cc01f723daa1f4e", "resourceType": "User" } }
HTTP Request Method |
GET |
URI |
https://hs-identity-api.oracleindustry.com/scim/v1/<tenant>/Users/{id} |
Request schema URI |
NA |
Response schema URI |
urn:scim:schemas:core:2.0:User |
HTTP Response Codes |
The following response codes apply:
For more information, see Section 2.4, "Return Codes". |
Request
GET /scim/v1/mypharma/Users/5a5dc886031d49088cc01f723daa1f4e HTTP 1.1 Host: example.com Authorization: Basic Y3VzdG9tZXIuYWRtaW51c2VyOnBhc3N3b3Jk= Accept: application/json
Response
HTTP/1.1 200 OK Content-Type: application/json Content-Length: ... Location https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/ Users/5a5dc886031d49088cc01f723daa1f4e
{ "schemas" : [ "urn:scim:schemas:core:2.0:User" ], "id" : "5a5dc886031d49088cc01f723daa1f4e", "externalId" : "john.doe@mypharma.com", "userName" : "JOHN.DOE", "name" : { "familyName" : "Doe", "givenName" : "John" }, "emails" : [ { "value" : "john.doe@mypharma.com", "type" : "work" } ], "phoneNumbers" : [ { "value" : "555-555-5555", "type" : "work" } ], "userType" : "LIVE", "active" : true, "meta" : { "created" : "2014-02-30T14:02:57Z", "lastModified" : "2014-02-30T14:02:57Z", "location": "https://hs-identity- api.oracleindustry.com/scim/v1/mypharma/Users/5a5dc886031d49088cc01f723daa1f4e", "resourceType": "User" } }
The HTTP GET method searches for a user based on the filter query parameter. Wildcard characters are not allowed in the filter value. If a user is found, GET returns only one result object.
The result set returns the entire user object. This can be restricted to return only the attributes specified in the attributes query parameter
Allowed filters: userName, externalId.
Sample: /Users?filter=userName+Eq+"john.doe"&attributes=id,externalId
HTTP Request Method |
GET |
URI |
https://hs-identity-api.oracleindustry.com/scim/v1/<tenant>/Users |
Query Parameters |
filter={filterName} A filter is required. The allowed filter names are externalId and userName. |
Request schema URI |
NA |
Response schema URI |
urn:scim:schemas:core:2.0:ListResponse |
HTTP Response Codes |
The following response codes apply:
For more information, see Section 2.4, "Return Codes". |
Request
GET /scim/v1/mypharma/Users?filter=externalId+Eq+"john.doe@mypharma.com"&attributes=id,externalId HTTP 1.1 Host: example.com Authorization: Basic Y3VzdG9tZXIuYWRtaW51c2VyOnBhc3N3b3Jk= Accept: application/json
Response
HTTP/1.1 200 OK Content-Type: application/json Content-Length: ...
{ "schemas" : [ "urn:scim:schemas:core:2.0:ListResponse" ], "totalResults" : 1, "Resources" : [ { "schemas" : [ "urn:scim:schemas:core:2.0:User" ], "id" : "82be808061044f9e9cef4c8f08d53ef0", "externalId" : "john.doe@mypharma.com" } ] }
To maintain an audit history, a user cannot be deleted from the OHSIAMS application. Instead, the account is disabled and all the current roles or groups are revoked for this user account.
For more details on user resources related to DELETE, see Section 2.2.1, "Users".
HTTP Request Method |
DELETE |
URI |
https://hs-identity-api.oracleindustry.com/scim/v1/<tenant>/Users |
Request schema URI |
NA |
Response schema URI |
NA |
HTTP Response Codes |
The following response codes apply:
For more information, see Section 2.4, "Return Codes". |
The SCIM /Groups resource endpoint assigns and revokes users from an OHSIAMS group. Only the operations listed below are supported.
HTTP Request Method |
GET |
URI |
https://hs-identity-api.oracleindustry.com/scim/v1/<tenant>/Groups |
Request schema URI |
NA |
Response schema URI |
urn:scim:schemas:core:2.0:ListResponse |
HTTP Response Codes |
The following response codes apply:
For more information, see Section 2.4, "Return Codes". |
Request
GET /scim/v1/mypharma/Groups HTTP 1.1 Host: example.com Authorization: Basic Y3VzdG9tZXIuYWRtaW51c2VyOnBhc3N3b3Jk= Accept: application/json
Response
HTTP/1.1 200 OK Content-Type: application/json Content-Length: ...
{ "schemas" : [ "urn:scim:schemas:core:2.0:ListResponse" ], "totalResults" : 3, "Resources" : [ { "id" : "mypharma.lshdme" }, { "id" : "mypharma.pfst50" }, { "id" : "mypharma.argussafety" } ] }
HTTP Request Method |
GET |
URI |
https://hs-identity-api.oracleindustry.com/scim/v1/<tenant>/Groups/{groupname} |
Request schema URI |
NA |
Response schema URI |
urn:scim:schemas:core:2.0:Group |
HTTP Response Codes |
The following response codes apply:
For more information, see Section 2.4, "Return Codes". |
Request
GET /scim/v1/mypharma/Groups/mypharma.lhsdme HTTP 1.1 Host: example.com Authorization: Basic Y3VzdG9tZXIuYWRtaW51c2VyOnBhc3N3b3Jk= Accept: application/json
Response
HTTP/1.1 200 OK Content-Type: application/json Content-Length: ...
{ "schemas" : [ "urn:scim:schemas:core:2.0:Group" ], "id" : "mypharma.lshdme", "displayName" : "lshdme", "members" : [ { "value" : "82be808061044f9e9cef4c8f08d53ef0", "display" : "tony.stark", "$ref" : "https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/Users/82be808061044f9e9cef4c8f08d53ef0" },
{ "value" : "8a0722126d914a5faa3d18ab806d2310", "display" : "mjack635375460126150000", "$ref" : "https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/Users/8a0722126d914a5faa3d18ab806d2310" }, { "value" : "47af6c8070c54eb4bfcf60554e582ac1", "display" : "user123abc456id", "$ref" : "https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/Users/47af6c8070c54eb4bfcf60554e582ac1" } ], "meta" : { "created" : "2014-06-01T14:22:38Z", "resourceType" : "Group" } }
Table 3-9 Modify Group Membership
HTTP Request Method |
PATCH |
URI |
https://hs-identity-api.oracleindustry.com/scim/v1/<tenant>/Groups/{groupname} |
Request schema URI |
JSON PATCH format |
Response schema URI |
urn:scim:schemas:core:2.0:Group |
HTTP Response Codes |
The following response codes apply:
For more information, see Section 2.4, "Return Codes". |
Request
PATCH /scim/v1/mypharma/Groups/mypharma.lhsdme HTTP 1.1 Host: example.com Authorization: Basic Y3VzdG9tZXIuYWRtaW51c2VyOnBhc3N3b3Jk= Accept: application/json Content-Type: application/json Content-Length: ...
{ "op":"add", "path":"members", "value":[ { "value": "2819c2237f76453a919d413861904646" }, { "value": "c68580ea3b82486a969b2b801ffd2aa8" } ] }
Response
HTTP/1.1 200 OK Content-Type: application/json Content-Length: ...
{ "schemas" : [ "urn:scim:schemas:core:2.0:Group" ], "id" : "mypharma.lshdme", "displayName" : "lshdme", "members" : [ { "value" : "82be808061044f9e9cef4c8f08d53ef0", "display" : "tony.stark", "$ref" : "https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/Users/82be808061044f9e9cef4c8f08d53ef0" }, { "value" : "2819c2237f76453a919d413861904646", "display" : "mjack635375460126150000", "$ref" : "https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/Users/8a0722126d914a5faa3d18ab806d2310" }, { "value" : " c68580ea3b82486a969b2b801ffd2aa8", "display" : "user123abc456id", "$ref" : "https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/Users/47af6c8070c54eb4bfcf60554e582ac1" } ], "meta" : { "created" : "2014-06-01T14:22:38Z", "resourceType" : "Group" } }
Request
PATCH /scim/v1/mypharma/Groups/mypharma.lhsdme HTTP 1.1 Host: example.com Authorization: Basic Y3VzdG9tZXIuYWRtaW51c2VyOnBhc3N3b3Jk= Accept: application/json Content-Type: application/json Content-Length: ...
Response
HTTP/1.1 200 OK Content-Type: application/json Content-Length: ...
{ "schemas" : [ "urn:scim:schemas:core:2.0:Group" ], "id" : "mypharma.lshdme", "displayName" : "lshdme", "members" : [ { "value" : "82be808061044f9e9cef4c8f08d53ef0", "display" : "tony.stark", "$ref" : "https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/Users/82be808061044f9e9cef4c8f08d53ef0" } ], "meta" : { "created" : "2014-06-01T14:22:38Z", "resourceType" : "Group" } }
Request
PATCH /scim/v1/mypharma/Groups/mypharma.lhsdme HTTP 1.1 Host: example.com Authorization: Basic Y3VzdG9tZXIuYWRtaW51c2VyOnBhc3N3b3Jk= Accept: application/json Content-Type: application/json Content-Length: ...
{ "op":"remove", "path":"members" }
Response
HTTP/1.1 200 OK Content-Type: application/json Content-Length: ...
{ "schemas" : [ "urn:scim:schemas:core:2.0:Group" ], "id" : "mypharma.lshdme", "displayName" : "lshdme", "members" : [ ], "meta" : { "created" : "2014-06-01T14:22:38Z", "resourceType" : "Group" } }
The SCIM /Bulk resource endpoint sends a potentially large collection of resource operations in a single request.
Bulk operations are handled in the order they appear in the POST content. When using the surrogate bulkId, you must ensure that the POST operation that generates the ID for the bulkId occurs before any update operations are performed for that bulkId.
HTTP Request Method |
POST |
URI |
https://hs-identity-api.oracleindustry.com/scim/v1/<tenant>/Bulk |
Request schema URI |
urn:scim:schemas:core:2.0:BulkRequest |
Response schema URI |
urn:scim:schemas:core:2.0:BulkResponse |
HTTP Response Codes |
The following response codes apply:
For more information, see Section 2.5, Return Codes. |
Note:
A successful POST on Bulk might not mean that the entire set of operations is successful. The client must iterate the BulkResponse to validate the status of each operation.Request
POST /scim/v1/mypharma/Bulk HTTP 1.1 Host: example.com Authorization: Basic Y3VzdG9tZXIuYWRtaW51c2VyOnBhc3N3b3Jk= Accept: application/json Content-Type: application/json Content-Length: ...
{ "schemas": ["urn:scim:schemas:core:2.0:BulkRequest"], "failOnErrors":1, "Operations":[ { "method":"POST", "path":"/Users", "bulkId":"qwerty", "data":{ "schemas": ["urn:scim:schemas:core:2.0:User"], "userName":"Alice" } }, { "method":"PUT", "path":"/Users/b7c14771-226c-4d05-8860-134711653041", "data":{ "schemas": ["urn:scim:schemas:core:2.0:User"], "id":"b7c14771134711653041", "userName":"Bob" } }, { "method": "PATCH", "path": "/Users/5d8d29d3a3cb6763ffcc", "data": [ { "op": "remove", "path": "phoneNumbers" }, { "op": "replace", "path": "userName", "value": "Jonh.doe@mypharma.com" } ] }, { "method":"DELETE", "path":"/Users/e90253151e07454e468b" } ] }
Response
HTTP/1.1 200 OK Content-Type: application/json Content-Length: ...
{ "schemas": ["urn:scim:schemas:core:2.0:BulkResponse"], "Operations": [ { "location": "https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/Users/92b725cd01f8e146b87a", "method": "POST", "bulkId": "qwerty", "status": { "code": "201" } }, { "location": "https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/Users/b7c14771134711653041", "method": "PUT", "status": { "code": "200" } }, { "location": "https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/Users/5d8d29d3a3cb6763ffcc", "method": "PATCH", "status": { "code": "200" } }, { "location": "https://hs-identity-api.oracleindustry.com/scim/v1/mypharma/Users/e90253151e07454e468b", "method": "DELETE", "status": { "code": "204" } } ] }
Request
POST /scim/v1/mypharma/Bulk HTTP 1.1 Host: example.com Authorization: Basic Y3VzdG9tZXIuYWRtaW51c2VyOnBhc3N3b3Jk= Accept: application/json Content-Type: application/json Content-Length: ...
{ "schemas" : [ "urn:scim:schemas:core:2.0:BulkRequest" ], "failOnErrors" : 1, "Operations" : [ { "method" : "POST", "path" : "/Users", "bulkId" : "qwerty", "data" : { "schemas" : [ "urn:scim:schemas:core:2.0:User" ], "externalId" : "bulk.user@mypharma.com", "userName" : "bulk.user@mypharma.com", "name" : { "familyName" : "User", "givenName" : "Bulk" }, "emails" : [ { "value" : "bulk.user@mypharma.com", "type" : "work" } ], "password" : "Welcome1" } }, { "method" : "PATCH", "path" : "/Groups/mypharma.lshdme", "data" : { "op" : "add", "path" : "members", "value" : [ { "value" : "bulkId:qwerty" } ] } } ] }
Response
HTTP/1.1 200 OK Content-Type: application/json Content-Length: ...
{ "schemas" : [ "urn:scim:schemas:core:2.0:BulkResponse" ], "Operations" : [ { "location" : "http://hs-identity-api.oracleindustry.com/scim/v1/mypharma/Users/c1f6f0df5e80498bb0d34c62b27694c9", "method" : "POST", "bulkId" : "qwerty", "path" : "/Users", "status" : { "code" : "201" } }, { "method" : "PATCH", "path" : "/Groups/mypharma.lshdme", "status" : { "code" : "200" } } ] }