Skip to end of metadata
Go to start of metadata

Table of Contents

Previous steps

Please note that the SCIM REST Web Service Add-on installed must be installed, please check this part in 8. How to use SCIM in Soffid # Installation

Please note that a user with the authentication is required, please check this part in 8. How to use SCIM in Soffid # Confirm authorization

Please note that is recommended to use a REST client, please see our example in 6. Testing tool # RESTer

Please note that you the correct header parameters must be used, please browse them in 2. SCIM in Soffid # HTTP request

Users

List all

List all users. Active or not. For example after the Soffid installation the admin user already exists.

List by id

List a user by its id (primary key). For example the admin user listed previously.

 

List by filter

List all users with a filter expression. For example, one can search active users with id greater than 50 and its user starting with 'a'.

 

Create

One may create a user. This user will be used for next examples.

 

Update partial

Update only the attributes with changes, only these attributes will be updated in the user, the rest will maintain the same value.

 

Update all

This operation replaces all values in the user. For example we will update nationalID.

  • Note that the attribute id is required to confirm that the resource "...User/<id>" is the same that the JSON user.
  • Note that all the attributes not included in the request will be cleared in the user and their data will be lost.
  • Note that not all the attributes are updatable, for example tag meta, avoid these tags. For more information see 3. Resource data model

 

Delete

Delete a user and its relations (groups, accounts, attributes, secondary groups, etc).

  • Please note that after this delete action, you will need to create again the user to use it in the next examples.

 

Groups

List all

List all groups. Obsolete or not. For example after the Soffid installation these are the available groups.

List by id

List a group by its id (primary key). For example the first group of the list.

 

List by filter

List all groups with a filter expression. For example, one can search groups between the ids 50 (included) and 56 (excluded).

 

Create

One can create a group. This group will be used for the next examples.

 

Update partial

Update only of the attributes with changes, only these attributes will be updated in the group, the rest will have the same value.

For example we will add value to a new attribute.

 

Update all

This operation replaces all values in the group. For example we will update driveLetter.

  • Note that the attribute id is required to confirm that the resource "...Group/<id>" is the same that the JSON group.
  • Note that all the attributes not included in the request will be cleared in the group and their data will be lost.
  • Note that not all the attributes are updatable, for example tag meta, avoid these tags. For more information see 3. Resource data model

 

Delete

Delete a group is not possible in this version, you must disable it with a PATCH operation.

  • Please note that after this delete, the group must be updated to use it in the following examples.

 

Account

List all

List all accounts. Disabled or not. For example after the Soffid installation these are the available account.

List by id

List an account by its id (primary key). For example the previous account.

 

List by filter

List all accounts with a filter expression. For example, one can search the account with different operators.

 

Create

One can create an account . We will use this account for the following examples.

 

Update partial

Update only of the attributes with changes, only these atrributes will be updated in the account, the rest will maintain the same value.

For example we will update the description.

 

Update all

This operation replace all values in the account. For example we will update the description.

  • Note that the attribute id is required to confirm that the resource "...Account/<id>" is the same that the JSON account.
  • Note that all the attributes not included in the request will be cleared in the account and their data will be lost.
  • Note that not all the attributes are updatable, for example tag meta, avoid these tags. For more information see 3. Resource data model

 

Delete

Delete an account.

  • Please note after this delete, the account has to be created again to use it in the next examples.

 

 

 

Extended user

ToDo

Assign a user into a group

ToDo

Remove a user from a group

ToDo

Assign a user into an account

ToDo

Remove an account of a user

ToDo

 

 
  • No labels