Note: this component stores cluster-wide configuration data and is mirrored across all servers in the topology within the the same cluster.
Note: changes to cluster-wide configuration objects are immediately and automatically mirrored across all servers within the same cluster, so offline changes are not supported.
A SCIM Attribute defines a SCIM attribute.
↓Relations from This Component
↓Relations to This Component
↓Properties
↓dsconfig Usage
The following components have a direct composition relation from SCIM Attributes:
The following components have a direct composition relation to SCIM Attributes:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ name | |
| ↓ type | |
| ↓ required | |
| ↓ case-exact | |
| ↓ multi-valued | |
| ↓ canonical-value | |
| ↓ mutability | |
| ↓ returned | |
| ↓ reference-type |
| Description | A description for this SCIM Attribute |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The name of the attribute. |
| Default Value | None |
| Allowed Values | A SCIM attribute name is composed of alphanumeric characters, the '$', '-' and '_' characters, and must start with a letter. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the data type for this attribute. |
| Default Value | string |
| Allowed Values | string - A sequence of zero or more Unicode characters encoded using UTF-8. boolean - The literal "true" or "false". datetime - A date and time encoded as a valid xsd:dateTime (e.g. 2008-01-23T04:56:22Z). decimal - A real number with at least one digit to the left and right of the period. integer - A decimal number with no fractional digits. binary - Arbitrary binary data. reference - A URI for a resource. A resource MAY be a SCIM resource, an external link to a resource (e.g., a photo), or it may be an identifier such as a URN. The reference-type property must be specified for attributes of this data type. complex - A singular or multi-valued attribute whose value is a composition of one or more simple attributes, called sub-attributes. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies whether this attribute is required. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies whether the attribute values are case sensitive. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies whether this attribute may have multiple values. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the suggested canonical type values for the attribute. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the circumstances under which the values of the attribute can be written. |
| Default Value | read-write |
| Allowed Values | read-only - The attribute cannot be modified. read-write - The attribute may be updated and read at any time. immutable - The attribute may have its initial values set at any time, but cannot be modified thereafter. write-only - The attribute may be updated at any time but cannot be read. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the circumstances under which the values of the attribute are returned in response to a request. |
| Default Value | by-default |
| Allowed Values | by-default - The attribute is returned by default in all SCIM responses where attribute values are returned. If the GET request 'attributes' parameter is specified, the attribute is only returned if it is named in the attributes parameter. upon-request - The attribute is returned in response to any PUT, POST, or PATCH operations if the attribute was specified by the client (for example, the attribute was modified). The attribute is returned in a SCIM query operation only if specified in the 'attributes' request parameter. always - The attribute is always returned regardless of the contents of the 'attributes' request parameter. never - The attribute is never returned. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the SCIM resource types that may be referenced. This property is only applicable for attributes that are of type 'reference'. Valid values are: A SCIM resource type (e.g., 'User' or 'Group'), 'external' - indicating the resource is an external resource (e.g., such as a photo), or 'uri' - indicating that the reference is to a service endpoint or an identifier (such as a schema urn). |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured SCIM Attributes:
dsconfig list-scim-attributes
[--property {propertyName}] ...
To view the configuration for an existing SCIM Attribute:
dsconfig get-scim-attribute-prop
--attribute-name {name}
--schema-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing SCIM Attribute:
dsconfig set-scim-attribute-prop
--attribute-name {name}
--schema-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new SCIM Attribute:
dsconfig create-scim-attribute
--attribute-name {name}
--schema-name {name}
[--set {propertyName}:{propertyValue}] ...
To delete an existing SCIM Attribute:
dsconfig delete-scim-attribute
--attribute-name {name}
--schema-name {name}