User resource data model

/User

Dictionary table

The diagram service model of the object: http://www.soffid.org/doc/console/2.9.0/uml/com/soffid/iam/api/User.html

Soffid allows you to add customized data to the user object. You can do that on metadata, on the proper object.

  • Main Menu > Administration > Configure Soffid > Global Settings > Metadata

It is allowed to consult all the User definition using the Schema query:

GET http://<your-domain>/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.api.User

Full JSON example

Request

GET http://<your-domain>/webservice/scim2/v1/User/1057751

Response 200 OK

{
    "lastName": "Smith",
    "comments": "Changed",
    "createdByUser": "admin",
    "fullName": "John Smith",
    "active": false,
    "userName": "jsmith",
    "mailAlias": "",
    "firstName": "John",
    "createdDate": "2020-12-14 17:52:14",
    "multiSession": false,
    "meta": {
        "location": "http://<your-server>/webservice/scim2/v1/User/1057751",
        "links": {
            "roleAccounts": "http://<your-domain>/webservice/scim2/v1/RoleAccount?filter=userCode+eq+'jsmith'+and+enabled+eq+true",
            "groupUsers": "http://<your-domain>/webservice/scim2/v1/GroupUser?filter=user+eq+'jsmith'+and+disabled+eq+false",
            "accounts": "http://<your-domain>/webservice/scim2/v1/Account?filter=type+eq+U+and+users.user.userName+eq+'jsmith'"
        },
        "resourceType": "User"
    },
    "modifiedByUser": "admin",
    "schemas": [
        "urn:soffid:com.soffid.iam.api.User"
    ],
    "modifiedDate": "2021-01-03 13:26:57",
    "attributes": {
        "RegisterServiceProvider": "anonymous",
        "manager": "admin",
        "EMAIL": "jsmith@test.com",
        "birthDate": "1970-05-26 00:00:00"
    },
    "id": 1057751,
    "userType": "I",
    "primaryGroupDescription": "Enterprise",
    "primaryGroup": "enterprise"
}

Response Error

For more infomation about response error visit https://bookstack.soffid.com/link/116#bkmrk-error-response