Skip to main content

User resource

/User

Dictionary table

The diagram service model of the object: https://download.soffid.com/doc/console/4.0.0/uml/com/soffid/iam/base/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 > Configuration > Global Settings > Metadata

Query schema

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

Request
GET https://<your-domain>/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.base.api.User
Response 200 OK
{
  "meta": {
    "location": "https://console.soffid4.local:8443/soffid/webservice/scim2/v1/Schemas/urn:soffid:com.soffid.iam.base.api.User",
    "resourceType": "Schema"
  },
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Schema"
  ],
  "name": "User",
  "description": "User object",
  "attributes": [
    {
      "uniqueness": "none",
      "name": "userName",
      "mutability": "readWrite",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": true
    },
    {
      "uniqueness": "none",
      "name": "firstName",
      "mutability": "readWrite",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": true
    },
    {
      "uniqueness": "none",
      "name": "lastName",
      "mutability": "readWrite",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": true
    },
    {
      "uniqueness": "none",
      "name": "middleName",
      "mutability": "readWrite",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "fullName",
      "mutability": "readOnly",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "userType",
      "mutability": "readWrite",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": true
    },
    {
      "uniqueness": "none",
      "name": "primaryGroup",
      "mutability": "readWrite",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": true
    },
    {
      "uniqueness": "none",
      "name": "homeServer",
      "mutability": "readWrite",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "profileServer",
      "mutability": "readWrite",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "emailAddress",
      "mutability": "readWrite",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "mailAlias",
      "mutability": "readWrite",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "mailServer",
      "mutability": "readWrite",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "active",
      "mutability": "readWrite",
      "type": "boolean",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "multiSession",
      "mutability": "readWrite",
      "type": "boolean",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "comments",
      "mutability": "readWrite",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "createdBy",
      "mutability": "readOnly",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "createdOn",
      "mutability": "readOnly",
      "type": "dateTime",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "modifiedBy",
      "mutability": "readOnly",
      "type": "string",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "uniqueness": "none",
      "name": "modifiedOn",
      "mutability": "readOnly",
      "type": "dateTime",
      "caseExact": true,
      "returned": "default",
      "multiValued": false,
      "required": false
    },
    {
      "subattributes": [
        {
          "uniqueness": "none",
          "name": "avatar",
          "description": "Avatar",
          "mutability": "readWrite",
          "type": "string",
          "caseExact": true,
          "returned": "default",
          "multiValued": false,
          "required": false
        }
      ],
      "uniqueness": "none",
      "name": "attributes",
      "description": "Custom attributes",
      "mutability": "readWrite",
      "type": "complex",
      "returned": "default",
      "multiValued": false
    },
    {
      "subattributes": [
        {
          "uniqueness": "none",
          "name": "domain",
          "description": "Password domain to be changed. By default, the DEFAULT domain is changed",
          "mutability": "writeOnly",
          "type": "string",
          "caseExact": true,
          "multiValued": false,
          "required": false
        },
        {
          "uniqueness": "none",
          "name": "value",
          "description": "The password itself, in  clear text",
          "mutability": "writeOnly",
          "type": "string",
          "caseExact": true,
          "multiValued": false,
          "required": true
        },
        {
          "uniqueness": "none",
          "name": "expired",
          "description": "If not set to false, the user will be prompted to change it on next logon",
          "mutability": "readWrite",
          "type": "boolean",
          "caseExact": true,
          "multiValued": false,
          "required": false
        }
      ],
      "uniqueness": "none",
      "name": "password",
      "description": "Change current user password",
      "mutability": "writeOnly",
      "type": "complex",
      "caseExact": true,
      "multiValued": true,
      "required": false
    }
  ],
  "id": "urn:soffid:com.soffid.iam.base.api.User"
}

Full JSON example

Visit SCIM User examples page

Back to top