Retrieving Directory-Synced Custom Attributes via SCIM API - VMware Identity Manager

Products

• VCF Operations/Automation (formerly VMware Aria Suite)

Issue/Introduction

When integrating Aria Automation with Workspace ONE Access (vIDM), you may need to retrieve user attributes (e.g., costCenter, employeeID) that are synced from your external directory (Active Directory). Standard User Search APIs (such as the CSP Gateway APIs) typically output core user profile data and do not aggregate directory-synced custom attributes. To programmatically access these values, you must use the vIDM SCIM API.

Environment

Aria Automation 8.18.1

VMware Identity Manager 3.3.7

Resolution

To retrieve custom attributes for a user, use the SCIM user endpoint. Custom attributes are not returned as top-level properties; they are encapsulated within the SCIM schema extensions in the JSON payload.

1. Navigate to the vIDM Administrator Console (Identity & Access Management > Setup > User Attributes). Confirm the custom attribute is enabled and correctly mapped to the source directory attribute.
2. Ensure a directory synchronization has completed successfully to populate the attribute data for users.
3. Use a REST client to perform a GET request to the SCIM user endpoint: /SAAS/jersey/manager/api/scim/Users/{userId}
4. Review the JSON response payload. The attribute value will be located within the mapped SCIM schema extension. Common namespaces include:
   • urn:scim:schemas:extension:enterprise:1.0 (for standard enterprise attributes).
   • Your organization’s specific extension namespace (if a custom vIDM extension was created).
5. If the attribute is missing, confirm the attribute mapping is configured in the vIDM console and that the user is not returning a null value due to a sync failure in the directory source.

Additional Information

https://developer.broadcom.com/xapis/vmware-identity-manager-api/latest//SAAS/jersey/manager/api/scim/Users/id/get/