RLM Cloud SCIM Provisioning

SCIM Provisioning

SCIM patch operations format is required:

{
“schemas”:[“urn:ietf:params:scim:api:messages:2.0:PatchOp”],
“Operations”:[
{
“op”: “add|replace|remove”,
“path”: “attribute”
“value”: “”
},
…
]
}

SSO Users PATCH SCIM

Update an SSO User. This method updates only the supplied fields for the SSO User.

PATCH /id-api/Users/35 HTTP/1.1
Host: www.rlmcloud.com

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    { "op": "replace", "path": "active", "value": true },
    { "op": "replace", "path": "name.formatted", "value": "John Reprise" },
    { "op": "replace", "path": "emails", "value": [ { "value": "John@example.com", "primary": true } ] },
    { "op": "replace", "path": "phoneNumbers", "value": [ { "value": "+1-555-123-4567" } ] },
    { "op": "replace", "path": "title", "value": "Lead Engineer" },
    { "op": "replace", "path": "company", "value": "Reprise Software" },
    { "op": "replace", "path": "notes", "value": "VIP customer" },
    { "op": "add", "path": "active", "value": true },
    { "op": "add", "path": "name.formatted", "value": "John Reprise" },
    { "op": "add", "path": "emails", "value": [ { "value": "John@example.com", "primary": true } ] },
    { "op": "add", "path": "phoneNumbers", "value": [ { "value": "+1-555-123-4567" } ] },
    { "op": "add", "path": "title", "value": "Lead Engineer" },
    { "op": "add", "path": "company", "value": "Reprise Software" },
    { "op": "add", "path": "notes", "value": "VIP customer" },
    { "op": "remove", "path": "name.formatted", "value": "" },
    { "op": "remove", "path": "phoneNumbers", "value": [ { "value": "" } ] },
    { "op": "remove", "path": "title", "value": "" },
    { "op": "remove", "path": "company", "value": "" },
    { "op": "remove", "path": "notes", "value": "" }
  ]
}

SSO Users PATCH SCIM Enable/Disable a User

Example of enabling or disabling an ID Licensing user.

PATCH /id-api/Users/35 HTTP/1.1
Host: www.rlmcloud.com

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    { "op": "replace", "path": "active", "value": true }
  ]
}

SSO Users PATCH SCIM Change User Password

Example of updating the password of an ID Licensing user.

PATCH /id-api/Users/49 HTTP/1.1
Host: www.rlmcloud.com

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    { "op": "replace", "path": "password", "value": "new_password" }
  ]
}

SSO Groups PATCH SCIM

Update an SSO Group. This method updates only the supplied fields for the SSO Group.

PATCH /id-api/Groups/69 HTTP/1.1
Host: www.rlmcloud.com

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    { "op": "add", "path": "members", "value": [{ "value": "49" }] },
    { "op": "remove", "path": "members", "value": [{ "value": "49" }] },
    { "op": "replace", "path": "members", "value": [{ "value": "49" }] },
    { "op": "replace", "path": "active", "value": true }
  ]
}

SSO Groups PATCH SCIM Enable/Disable Group

Example of enabling or disabling an ID Licensing group.

PATCH /id-api/Groups/69 HTTP/1.1
Host: www.rlmcloud.com

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    { "op": "replace", "path": "active", "value": true }
  ]
}

SSO Users POST SCIM

Create an SSO User.

POST /id-api/Users HTTP/1.1
Host: www.rlmcloud.com

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "userName": "alice@example.com",
  "name": { "formatted": "Alice Example" },
  "emails": [{ "value": "alice@example.com", "primary": true }],
  "phoneNumbers": [{ "value": "+1-555-1234" }],
  "active": true,
  "title": "Engineer"
}

SSO Groups POST SCIM

Create an SSO Group.

POST /id-api/Groups HTTP/1.1
Host: www.rlmcloud.com

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "displayName": "Developers",
  "externalId": "dev-group"
}