SCIM Connector Features
Essential knowledge
Author:
Fluent Commerce
Changed on:
27 Oct 2023
Overview
There are a number of features provided as part of the SCIM Connector.Key points
- a guide on each Endpoint detail for fc-connector-scim
- These Endpoints supported a number of protocols
- Some Endpoints may not be supported at this stage
Below are the key features from
`fc-connector-scim`:Endpoints
See more detail in RFC 7644: System for Cross-domain Identity Management: Protocol| Endpoint | Description | Sample |
| GET /Users?filter=userName eq "" | Find a list of User Resource for the filter specified (Support filter by username only). | `curl --location --request GET 'http://localhost:8080/Users?filter=userName eq "test@fluentscimtest.onmicrosoft.com"' \ --header 'Authorization: Bearer <ApiKey>'` |
| GET /Users/{username} | Retrieves a User Resource by unique identifier. | `curl --location --request GET 'https://localhost:8080/Users/test@fluentscimtest.onmicrosoft.com' \ --header 'Authorization: Bearer <ApiKey>'` |
| POST /Users | Creates a new User Resource for the data specified. | `curl --location --request POST 'http://localhost:8080/Users' \ --header 'Authorization: Bearer <ApiKey>' \ --header 'Content-Type: application/json' \ --data-raw '{ "schemas": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User" ], "userName": "test@fluentscimtest.onmicrosoft.com", "active": true, "displayName": "Test User", "name": { "givenName": "Test", "familyName": "User" }, "emails": [ { "type": "work", "value": "test@fluentscimtest.onmicrosoft.com" } ], "roles": [ { "primary": false, "type": "WindowsAzureActiveDirectoryRole", "display": "AGENT_1023434_GRAPHQL", "value": "AGENT_1023434_GRAPHQL" } ], "meta": { "resourceType": "User" } } '` |
| PATCH /Users/{username} | Updates a new User Resource with the data specified. | `curl --location --request PATCH 'http://localhost:8080/Users/test@fluentscimtest.onmicrosoft.com' \ --header 'Authorization: Bearer <ApiKey>' \ --header 'Content-Type: application/json' \ --data-raw '{ "schemas": [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ], "Operations": [ { "op": "replace", "path": "emails[type eq \"work\"].value", "value": "updated.test@fluentscimtest.onmicrosoft.com" }, { "op": "replace", "value": { "displayName": "Updated Dev Fluent Retail" } } ] } '` |
| DELETE /Users/{username} | Deactivates a User Resource by given identifier. | `curl --location --request DELETE 'http://localhost:8080/Users/test@fluentscimtest.onmicrosoft.com' \ --header 'Authorization: Bearer <ApiKey>'` |
Endpoints supported by default
See more detail in RFC 7644: System for Cross-domain Identity Management: Protocol- /ME (GET, POST, PATCH, DELETE, PUT)
- /ServiceProvider (GET)
- /Schemas (GET)
- /ResourceTypes (GET)
- [prefix]/.search (POST)
Endpoints (not supported)
See more detail in RFC 7644: System for Cross-domain Identity Management: Protocol- /Users (PUT)
- /Groups (GET, POST, PATCH, DELETE, PUT)
- /Bulk (POST)
