Account Management
The Account Management Service Type provides write capabilities to Active Directory. These include operations to:
- Create, update or disable a User Account
- Add or remove a user from groups
- Create, update, or delete a group
- Add or remove users from a groups
The service is commonly used in on-boarding and off-boarding scenarios to manage user accounts. A service instance of this service type is registered automatically when you install K2.
Service Keys (Service Instance Configuration Settings)
Key | Can be modified | Data Type | Sample Value | Notes |
---|---|---|---|---|
DefaultOU | Yes | Text | CN=OU1 | Enter the default Organization Unit configured in the Active Directory structure of the environment. The DefaultOU must to be in the format ‘CN=OU1’ |
DefaultDomain | Yes | Text | DOMAIN1.COM | Enter the Domain Name configured for Active Directory. This field is required. |
CustomProperties | Yes | Text | If there are custom properties pertaining to the Active Directory environment then enter them here. |
Service Objects
The Account Management service exposes the following Service Objects:
- AD Group
- AD User
SmartObjects
If an AD environment is configured during installation, K2 automatically generates SmartObjects for the Service Objects in the Service. SmartObjects can be automatically created by selecting the Generate SmartObjects for this Service Instance check box when creating a new Service Instance. Designers can use the SmartObject design tools to build advanced SmartObjects that leverage the Service Objects in this service. It is recommended to use the SmartObject design tools to create SmartObjects rather than generating SmartObjects, since this allows better control over the naming, behavior and design of the SmartObject and its methods and properties.
Considerations
- The default Service Instance of this service is used internally by the K2 environment. Do not modify or delete the existing service instance. You can create a new instance or use the methods from the existing instance