Scim.json

Cautions¶

1. When changing parameters, please refer to "Confirmation When Changing Parameters".

Setting Values¶

The setting values of this parameter file are as follows.

Setting Example¶

{
    "Enabled": true,
    "SwaggerEnabled": false,
    "ExtendedAttributes": {
        "Users": [
            {
                "Schema": "urn:pleasanter:params:scim:schemas:extension:custom:2.0:User",
                "Name": "jobTitle",
                "ColumnName": "Users_ClassB"
            }
        ],
        "Groups": [
            {
                "Schema": "urn:pleasanter:params:scim:schemas:extension:custom:2.0:Group",
                "Name": "groupType",
                "ColumnName": "Groups_ClassA"
            }
        ]
    }
}

ExtendedAttributes¶

ExtendedAttributes is the setting for linking an "attribute" on the ID provider side to an "extended column" added to the "User Management" screen or the "Group Management" screen of Pleasanter.

For example, to store the attribute "jobTitle" on the ID provider side in the "extended column" "Users_ClassB" on the user management screen, set it as follows.

"ExtendedAttributes": {
    "Users": [
        {
            "Schema": "urn:pleasanter:params:scim:schemas:extension:custom:2.0:User",
            "Name": "jobTitle",
            "ColumnName": "Users_ClassB"
        }
    ],
    "Groups": []
}

ExtendedAttributes.Users¶

Sets the mapping of extended attributes for users.

Example:

"Users": [
    {
        "Schema": "urn:pleasanter:params:scim:schemas:extension:custom:2.0:User",
        "Name": "jobTitle",
        "ColumnName": "Users_ClassB"
    },
    {
        "Schema": "urn:pleasanter:params:scim:schemas:extension:custom:2.0:User",
        "Name": "officeLocation",
        "ColumnName": "Users_DescriptionA"
    }
]

In this example, the values are stored as follows.

In the attribute mapping on the Entra ID side, specify the full attribute name including the schema, as follows.

ExtendedAttributes.Groups¶

Sets the mapping of extended attributes for groups.

Example:

"Groups": [
    {
        "Schema": "urn:pleasanter:params:scim:schemas:extension:custom:2.0:Group",
        "Name": "groupType",
        "ColumnName": "Groups_ClassA"
    },
    {
        "Schema": "urn:pleasanter:params:scim:schemas:extension:custom:2.0:Group",
        "Name": "groupNote",
        "ColumnName": "Groups_DescriptionA"
    }
]

In this example, the values are stored as follows.

In the attribute mapping on the Entra ID side, specify the full attribute name including the schema, as follows.

In ExtendedAttributes.Users and ExtendedAttributes.Groups, set the following parameters.

Schema¶

Sets the extended schema of SCIM.

1. The schema setting on the Pleasanter side can be omitted.
2. In the attribute mapping on the ID provider side, the full attribute name must be set.

Name¶

Specify the trailing string of the attribute name used in the "attribute mapping" on the ID provider side.

SCIM attribute name on the ID provider side¶

urn:pleasanter:params:scim:schemas:extension:custom:2.0:User:jobTitle

Setting example of Name in Scim.json¶

"Name": "jobTitle"

ColumnName¶

Specify the column name of the "extended column" used as the storage destination on the Pleasanter side.

1. To store the value in an "extended column" added to the "User Management" screen, specify the column name of the "extended column" with the prefix Users_.
2. To store the value in an "extended column" added to the "Group Management" screen, specify the column name of the "extended column" with the prefix Groups_.

Example:

"ColumnName": "Users_ClassB"

Columns That Can Be Specified on the Pleasanter Side¶

What can be used as the storage destination of SCIM extended attributes are the "extended columns" of the "User Management" screen or the "Group Management" screen.

Mainly the following columns are specified.

Users_ClassA
Users_ClassB
Users_ClassC
Users_DescriptionA
Users_DescriptionB

Groups_ClassA
Groups_ClassB
Groups_ClassC
Groups_DescriptionA
Groups_DescriptionB

Extended columns of the Class type and the Description type can be used.

To display them on the screen, set the display names and so on separately in CustomDefinitions\Column.json.

Setting the Display Name of an Extended Column¶

To display an extended column on the screen of Pleasanter, set CustomDefinitions\Column.json.

Target folder:

Implem.Pleasanter\App_Data\Parameters\CustomDefinitions

File name:

Column.json

Setting example:

{
    "Users_ClassB": {
        "LabelText": "Job Title",
        "GridEnabled": "1",
        "EditorEnabled": "1"
    },
    "Groups_ClassA": {
        "LabelText": "Group Type",
        "GridEnabled": "1",
        "EditorEnabled": "1"
    }
}

In this example, they are displayed as follows.

Attribute Names to Specify on the Microsoft Entra ID Side¶

In the attribute mapping of Microsoft Entra ID, specify not only Name on the Pleasanter side but the full attribute name including the schema.

As an example, when the following is set in Scim.json:

{
    "Schema": "urn:pleasanter:params:scim:schemas:extension:custom:2.0:User",
    "Name": "jobTitle",
    "ColumnName": "Users_ClassB"
}

On the Entra ID side, specify the following value for the customappsso attribute.

urn:pleasanter:params:scim:schemas:extension:custom:2.0:User:jobTitle

If you specify only jobTitle, the integration may not work as expected.
Be sure to specify the full attribute name on the Entra ID side.

Supported Versions¶

Related Information¶

• Confirmation When Changing Parameters