Teamcenter SSO Account

Overview

You can configure your accounts in SnapLogic using the Designer or Manager. Use this account type to connect the Snaps in the PLM Teamcenter Snap Pack to a Teamcenter web tier with a JSON Web Token (JWT) that your identity provider issues, instead of a Teamcenter password. The account can take the Teamcenter user from a claim in the token, exchange the token through the On-Behalf-Of flow, or route the login through a Teamcenter Security Services (TcSS) gateway. This account uses the adapter that is embedded in the Snap Pack, so you do not have to deploy a separate adapter service.

Prerequisites

  • A running Teamcenter web tier that is reachable from your Snaplex.
  • An identity provider that issues the token, and the JSON Web Key Set (JWKS) endpoint of that provider.
  • A Teamcenter user that corresponds to the identity in the token, with the permissions required by the Snaps you want to run.
  • If you use the On-Behalf-Of flow, the tenant ID, client ID, client secret, and scope of the application that is registered with your identity provider.
  • If you use the Teamcenter Security Services gateway, the URL and application ID of that gateway.

Account settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description
Label*

String

Required. Specify a unique label for the account.

Default value: N/A

Teamcenter URL*

String

Specify the URL of the Teamcenter web tier that the Snaps must connect to.

Example: https://teamcenter.example.com/tc

Default value: N/A

Pool Profile

String

Specify the connection-pool profile that this account must use. Leave this field blank to use the default pool profile.

Default value: N/A

Enforce profile

Checkbox

Appears when Pool Profile contains a value.

Select this checkbox to enforce the pool profile that you specified in Pool Profile.

Default status: Deselected

Token*

String/Expression

Specify the token of the user that must log in to Teamcenter.

Default value: N/A

Validate token

Checkbox

Select this checkbox to validate the token against the issuing identity provider before the account accesses Teamcenter. When you select this checkbox, the account always takes the user from a claim in the token, and the On-Behalf-Of flow and the Teamcenter Security Services gateway are not available.

Default status: Deselected

User name/ID in token*

Checkbox

Appears when Validate token is deselected.

Select this checkbox to read the Teamcenter user name or ID from a claim in the token. Deselect it to specify the user explicitly in User.

Default status: Selected

User Claim*

String

Appears when User name/ID in token or Validate token is selected.

Specify the name of the claim that holds the Teamcenter user name or ID.

Default value: N/A

User*

String/Expression

Appears when User name/ID in token and Validate token are both deselected.

Specify the name or ID of the Teamcenter user that the Snaps must log in as.

Default value: N/A

Url for JWKS*

String

Appears when Validate token is selected.

Specify the endpoint that serves the JSON Web Key Set (JWKS) used to verify the token signature.

Default value: https://login.microsoftonline.com/common/discovery/v2.0/keys

Accepted Audience(s)

Appears when Validate token is selected.

Specify the audiences that the token may be issued for. If you add at least one row, the aud claim of the token must match one of the values you list. Leave the field set empty to accept any audience.

Audience

String

Specify one accepted value of the aud claim.

Default value: N/A

Accepted Scope(s)

Appears when Validate token is selected.

Specify the scopes that the token must grant. If you add at least one row, the scp claim of the token must match one of the values you list. Leave the field set empty to accept any scope.

Scope

String

Specify one accepted value of the scp claim.

Default value: N/A

Additional Claims

Appears when Validate token is selected.

Specify any further claims that the token must carry, and the value that each claim must have.

Claim

String

Specify the name of the claim to validate.

Default value: N/A

Value

String

Specify the value that the claim must have.

Default value: N/A

Group

String

Specify the name of the Teamcenter group that the session must run in. Leave this field blank to use the default group of the user.

Default value: N/A

Role

String

Specify the name of the Teamcenter role that the session must run in. Leave this field blank to use the default role of the user.

Default value: N/A

Project

String

Specify the ID of the Teamcenter project that the session must run in.

Default value: N/A

Share pool

Checkbox

Select this checkbox to share the connection pool with sessions that have the same key data, across account boundaries.

Default status: Deselected

Switch Group/Role/Project

Checkbox

Select this checkbox to switch the group, role, and project within the existing Teamcenter session instead of opening a new session.

Default status: Deselected

Use 'On Behalf Of Flow'

Checkbox

Appears when Validate token is deselected.

Select this checkbox to exchange the token for a Teamcenter token through the On-Behalf-Of flow of your identity provider.

Default status: Deselected

Tenant ID

String

Appears when Use 'On Behalf Of Flow' is selected.

Specify the ID of the tenant that issues the token.

Default value: N/A

Client ID

String

Appears when Use 'On Behalf Of Flow' is selected.

Specify the client ID of the application that is registered with your identity provider.

Default value: N/A

Client Secret

String

Appears when Use 'On Behalf Of Flow' is selected.

Specify the client secret of the registered application. The value is masked in the account dialog and is stored as a sensitive value.

Default value: N/A

Required Scope

String

Appears when Use 'On Behalf Of Flow' is selected.

Specify the scope that the exchanged token must be issued for.

Default value: N/A

Use TcSS gateway

Checkbox

Appears when Validate token is deselected.

Select this checkbox to log in through a Teamcenter Security Services (TcSS) gateway.

Default status: Deselected

URL

String

Appears when Use TcSS gateway is selected.

Specify the URL of the Teamcenter Security Services gateway.

Default value: N/A

App ID

String

Appears when Use TcSS gateway is selected.

Specify the application ID that identifies this client to the Teamcenter Security Services gateway.

Default value: N/A