NSD1416 Provisioning to PortWise with Automatic Account Manager
Fact
- Product: Nordic Edge Automatic Account Manager
- Action: Provisioning to PortWise, version 1.0
- Category: Process
- Platform: Any supported
- Revision History
Situation
How to use the Action Provisioning to PortWise
System Requirements
- Nordic Edge Automatic Account Manager 3.1 or later
Overview
Action for PortWise user account administration. Includes Add, Update and Delete methods via the PortWise XPI Web Service API.
The Action rely on some session attributes as userName, displayName, mail, dnLocation, and mobile exists in the session when the Action is triggered.
The session attribute PORTWISE_EXIST indicates if the account exist (true) or not (false).
Figure 1: The AAM Studio
Settings
Mandatory Settings
These settings are mandatory and must always contain a value.
|
Label |
Description/Example |
|
Administrator Username [MANDATORY] |
The PortWise admin account, example: admin@mycompany.com Example: administrator |
| Administrator Password [MANDATORY] | The PortWise admin password |
| Host Address [MANDATORY] | The PortWise Server Address and Port Number. Example: https://192.168.0.113:7071 |
Optional Settings
|
Label |
Description/Example |
| Authentication Web Service Path [OPTIONAL] |
The PortWise authentication web service soap path. Default value=/ws/services/Authenticate |
|
User Account Web Service Path [OPTIONAL] |
The PortWise user account web service soap path. Default value=/ws/services/UserAccount |
|
Session Attribute for Delete Operation [OPTIONAL] |
The name of the Delete Operation attribute. If this attribute value is set to true, the current account will be removed. If set to false the account will be updated. Default value=DELETE_OPERATION |
|
Session Attribute for Status [OPTIONAL] |
The result of the operation, CREATED, UPDATED, DELETED, UNLOCKED or FAILED is written to this session attribute. Default value=STATUS |
|
Delete Account (true/false) [OPTIONAL] |
If users in the session objects flagged as 'delete' should be deleted in PortWise. Requires username attribute. If this option is set to true, it will override any create or check operation.
Default value=false |
|
Create Account (true/false) [OPTIONAL] |
If users in the session objects flagged as 'create' should be created in PortWise. Requires username attribute. If this option is set to true, it will override any create or check operation. Default value=false |
|
Update Account (true/false) [OPTIONAL] |
If users in the session objects flagged as 'update' should be updated in PortWise. Requires username attribute. If this option is set to true, it will override any create or check operation. Affected attributes: Display name. Default value=false |
|
Unlock Account (true/false) [OPTIONAL] |
If users in the session objects should be unlocked if the account is locked in PortWise. Default value=false |
|
Unlock Account Service [OPTIONAL] |
1=Policy Service, 2=Authentication Service Default value=2 |
|
Session Attribute for User Name [OPTIONAL] |
The session attribute for user name. Default attribute name=userName |
|
Session Attribute for Display Name [OPTIONAL] |
The session attribute for display name. Default attribute name=displayName |
| Session Attribute for E-Mail Address [OPTIONAL] | The session attribute for e-mail.
Default attribute name=mail |
| Session Attribute for DN Location [OPTIONAL] | The session attribute for DN location.
Default attribute name=dnLocation |
| Session Attribute for SMS Number [OPTIONAL] | The session attribute for SMS number.
Default attribute name=mobile |
| Valid from Date [OPTIONAL] | Format yyyy-MM-dd HH:mm:ss.
Leave blank to set the current date as the account creation date. Supports SESSION parameters |
| Valid to Date [OPTIONAL] | Format yyyy-MM-dd HH:mm:ss or enter number of days ahead of current date.
Leave blank to set 90 days ahead the current date as account Valid to Date. Supports SESSION parameters |
Examples
Example 1 - Create/Update Account (configured in figure 1)
If Create Account is set to true:
Create a PortWise account in the PortWise database.
If Update Account is set to true:
If the account already exist, it will be updated if any of the provided attribute values differs from the current account attribute values.
Used settings:
|
Setting |
Value |
|
Administrator Username [MANDATORY] |
The PortWise admin account, example: admin@mycompany.com Example: administrator |
| Administrator Password [MANDATORY] | The PortWise admin password |
| Host Address [MANDATORY] | The PortWise Server Address and Port Number. Example: https://192.168.0.113:7071 |
| Create Account (true/false) [OPTIONAL] | true |
| Update Account (true/false) [OPTIONAL] | true |
Example 2 – Delete Account
Used settings:
|
Setting |
Value |
|
Administrator Username [MANDATORY] |
The PortWise admin account, example: admin@mycompany.com Example: administrator |
| Administrator Password [MANDATORY] | The PortWise admin password |
| Host Address [MANDATORY] | The PortWise Server Address and Port Number. Example: https://192.168.0.113:7071 |
| Delete Account (true/false) [OPTIONAL] | true |
Example 3 – Unlock Account
Used settings:
|
Setting |
Value |
|
Administrator Username [MANDATORY] |
The PortWise admin account, example: admin@mycompany.com Example: administrator |
| Administrator Password [MANDATORY] | The PortWise admin password |
| Host Address [MANDATORY] | The PortWise Server Address and Port Number. Example: https://192.168.0.113:7071 |
| Unlock Account (true/false) [OPTIONAL] | true |
| Unlock Account Service [OPTIONAL] |
1=Policy Service, 2=Authentication Service Default value=2 |
Revision History
|
Version/Date |
Note |
| Version 1.0 11th January |
Session attribute PORTWISE_EXIST was added, which indicates if an account exist or not. |
|
28th December 2011 |
Initial document |
DISCLAIMER
However, the information provided in this document is for your information only. Nordic Edge™ makes no explicit or implied claims to the validity of this information. Any trademarks referenced in this document are the property of their respective owners.
The origin of this information may be internal or external to Nordic Edge™. Nordic Edge™ makes all reasonable efforts to verify this information.
Nordic Edge Support - support.nordicedge.se
