Handler to retrieve, create, update, and delete users in i-net HelpDesk.

Returns either a list, or, if the <USER ID> is set, a single entry of users. The response conforms to Section 3.4.1 of RFC 7644. There is only simple filtering available for the Users-resource. Also, you can't specify the attributes to return.

Note: there is no PATCH support in this API.

# Request
GET /api/scim/v2/users HTTP/1.1
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
# Response
HTTP/1.1 200 OK
Content-Type: application/scim+json
 
{
  "totalResults": 19,
  "startIndex": 1,
  "itemsPerPage": 19,
  "Resources": [
    {
      "profileURL": "https://127.0.0.1:9000/usersandgroups/user/000000001ade633ff96c440b3",
      "displayName": "Bruce Scott",
      "externalId": "000000001ade633ff96c440b3",
      "active": true,
      "groups": [
        {
          "id": "sys09dlmeidonrthlu42m0jcc",
          "$ref": "https://127.0.0.1:9000/api/scim/v2/Groups/sys09dlmeidonrthlu42m0jcc"
        },
        {
          "id": "sys01og8a626ajrepb47rblh0",
          "$ref": "https://127.0.0.1:9000/api/scim/v2/Groups/sys01og8a626ajrepb47rblh0"
        },
        {
          "id": "0cx28urjt4d7akrc1as6vbjad",
          "$ref": "https://127.0.0.1:9000/api/scim/v2/Groups/0cx28urjt4d7akrc1as6vbjad"
        },
        {
          "id": "sys00paaukvarqba17x9hxc09",
          "$ref": "https://127.0.0.1:9000/api/scim/v2/Groups/sys00paaukvarqba17x9hxc09"
        }
      ],
      "userName": "admini",
      "photos": [
        {
          "type": "photo",
          "value": "https://127.0.0.1:9000/usersandgroups/?method=usersandgroupsmanager_geticon&hash=user%0A000000001ade633ff96c440b3"
        }
      ],
      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "organization": "Berlin"
      },
      "emails": [
        {
          "type": "work",
          "value": "admini@demo.local",
          "primary": true
        }
      ],
      "meta": {
        "location": "https://127.0.0.1:9000/api/scim/v2/Users/000000001ade633ff96c440b3",
        "lastModified": "2024-08-13T08:13:53Z",
        "resourceType": "User"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
      ],
      "name": {
        "formatted": "Bruce Scott",
        "familyName": "Scott",
        "givenName": "Bruce"
      },
      "id": "000000001ade633ff96c440b3"
    },
    ...
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ]
}

# Browser access
https://127.0.0.1:9000/api/scim/v2/users
 
# Shell access using curl
curl -LsH "Authorization: Bearer <access_token>" "https://127.0.0.1:9000/api/scim/v2/users"
 
# Shell access using curl using username and password
curl -Lsu username:password "https://127.0.0.1:9000/api/scim/v2/users"

Create a new user as per Section 3.3 of RFC 7644. After the user was created, it will be returned.

# Request
POST /api/scim/v2/users HTTP/1.1
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
{
  "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:User" ],
  ...
}
 
# Response
HTTP/1.1 201 OK
Content-Type: application/scim+json
 
{
  "profileURL": "https://127.0.0.1:9000/usersandgroups/user/000000001ade633ff96c440b3",
  "meta": {
    "location": "https://127.0.0.1:9000/api/scim/v2/Users/000000001ade633ff96c440b3",
    "lastModified": "2024-08-13T08:13:53Z",
    "resourceType": "User"
  },
  "displayName": "Bruce Scott",
  ...
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ]
}

Update a user as per Section 3.5.1 of RFC 7644. The user has to exist to be updated, as it will not be created. The update will not remove any information not provided in the update data request.

# Request
POST /api/scim/v2/users/000000001ade633ff96c440b3 HTTP/1.1
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
{
  ...
  "schemas" : [ "urn:ietf:params:scim:schemas:core:2.0:Users" ]
}
 
# Response
HTTP/1.1 201 OK
Content-Type: application/scim+json
 
{
  "profileURL": "https://127.0.0.1:9000/usersandgroups/user/000000001ade633ff96c440b3",
  "meta": {
    "location": "https://127.0.0.1:9000/api/scim/v2/Users/000000001ade633ff96c440b3",
    "lastModified": "2024-08-13T08:13:53Z",
    "resourceType": "User"
  },
  "displayName": "Bruce Scott",
  ...
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
  ]
}

Remove a user as defined by section 3.6 of RFC 7644

# Request
DELETE /api/scim/v2/groups/000000001ade633ff96c440b3 HTTP/1.1
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
# Response
HTTP/1.1 204 OK
Content-Type: application/scim+json