Skip to main content

Account resource data model

/Account

Dictionary table

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

Soffid allows you to add customized data to the groupAccount object. You can do that on metadata option:

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

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

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

Full JSON example

Request

GET http://<your-domain>/webservice/scim2/v1/Account/845085

Response 200 OK

{
    "grantedRoles": [],
    "description": "Test User",
    "type": "U",
    "ownerGroups": [],
    "loginName": "test",
    "inheritNewPermissions": false,
    "disabled": true,
    "id": 845085,
    "managerGroups": [],
    "grantedGroups": [],
    "lastPasswordSet": "2020-11-23 22:28:14",
    "passwordExpiration": "2020-11-23 22:28:14",
    "passwordPolicy": "I",
    "accessLevel": "-",
    "managerRoles": [],
    "created": "2020-11-13 15:39:52",
    "system": "soffid",
    "ownerRoles": [],
    "meta": {
        "location": "http://<your-domain>/webservice/scim2/v1/Account/845085",
        "links": {
            "roleAccounts": "http://<your-domain>/webservice/scim2/v1/RoleAccount?filter=account.id+eq+845085+and+enabled+eq+true",
            "users": "http://<your-domain>/webservice/scim2/v1/User?filter=accountAccess.account.id+eq+845085+or+accounts.account.id+eq+845085"
        },
        "resourceType": "Account"
    },
    "schemas": [
        "urn:soffid:com.soffid.iam.api.Account"
    ],
    "name": "test",
    "managerUsers": [],
    "attributes": {},
    "status": "d",
    "ownerUsers": [
        "test"
    ],
    "grantedUsers": []
}

Response Error

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