Register ApiAdapter client
- Last UpdatedJun 04, 2024
- 2 minute read
Note: Ensure that command is one long string without any carriage returns. Any returns in the command will cause an error.
Parameters for Powershell commands for ApiAdapter client
An explanation of the parameters used in the Powershell commands for ApiAdapter client.
|
Parameter |
Description |
|---|---|
|
Id |
The Id should reflect the purpose of the client. For example, osmclientapiadapterprod or osmclientapiadapteruat. This is the value that the OSM installer will require. |
|
Name |
Must be equal to value for Id parameter. |
|
HostBase |
The machine/server name where PCS is installed. |
|
AccessTokenLifetime |
The validity time of the access token for AVEVA Identity Manager. The recommended value is 600 seconds. |
|
IdentityTokenLifetime |
The validity time of the access token for AVEVA Identity Manager. The recommended value is 600 seconds. |
Register ApiAdapter client with Add command
-
Open Windows PowerShell in Administrator mode.
-
Enter the first command statement.
Add-IdentityManagerClient -HostBase "https://pcs_server_name.company.com" -Id osmclientapiadapterprod -Name osmclientapiadapterprod -Secret osmapiadapterclientsecret -ScopeRestrictions "openid" -AllowedGrantTypes "windowsintegrated" -AccessTokenLifetime 600 -IdentityTokenLifetime 600
The results should look like this.
-
Close PowerShell by exit.
-
Restart the AVEVA Identity Manager service.
