Skip to main content
Version: 2026.10

Auth Integrations

Your external applications are most likely protected by an auth provider — an OAuth or OpenID Connect (OIDC) service, or a username-and-password (basic) login. To let the platform sign in to one of these applications on a user's behalf, an administrator registers how that application authenticates.

Credentials are encrypted at rest. They are never attached to a queued job: when an agent claims an authenticated job, the platform issues a short-lived encrypted payload so that only that one agent can read it, and the agent removes it after the job finishes.

How agents receive credentials​

Agents that run authenticated jobs receive each sign-in encrypted specifically for them and decrypt it automatically — no manual key setup is required. An agent provisions and registers its own key the first time it starts.

Configuring a sign-in​

Administrators choose how an app authenticates when they add its integration. Applications you can connect lists the sign-in standard each app uses, and the same page has step-by-step setup for Teamwork Cloud with OIDC, Google Drive, Microsoft 365, IBM DOORS Next and a Windchill service account. For the apps you can connect Resources from, see Supported apps.

Registration Information​

To delegate authorization to an agent most auth providers require credentials or other private information referred to as Registration Information. The format for registration information depends on the auth protocol used. The following protocols are supported:

  • OAuth 2.0
  • Basic Login
  • Token

Details on the schemas for registration information can be found below.

OAuth 2.0 Registration​

Title: OAuth 2.0 Registration

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: A registration secret for OAuth 2.0 authorization. The secret must be registered in order for functions to utilize OAuth2 authorization.

PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ authorizationIssuerNostringNo-Authorization Issuer
+ clientIdNostringNo-Client ID
+ scopeNostringNo-Scope
- pkceEnabledNobooleanNo-PKCE

Example: OAuth 2.0​

{
"clientId": "client-id-1234567890",
"authorizationIssuer": "https://accounts.google.com",
"scope": "https://www.googleapis.com/auth/documents.readonly",
"pkceEnabled": true
}

1. Property Basic Registration > authorizationIssuer​

Title: Authorization Issuer

Typestring
RequiredYes
Formaturi

Description: The URL of the authorization server that generates and signs access tokens.

Restrictions
Min length1

2. Property Basic Registration > clientId​

Title: Client ID

Typestring
RequiredYes

Description: Identifies the set of functions requesting access to resources protected by the auth server.

3. Property Basic Registration > scope​

Title: Scope

Typestring
RequiredYes

Description: A space separated list of permissions requested by the set of functions.

Example:

"read write profile email offline_access"

4. Property Basic Registration > pkceEnabled​

Title: PKCE

Typeboolean
RequiredNo
Defaultfalse

Description: Whether or not the authorization server supports PKCE. Only PKCE with S256 code challenges is supported.

Examples:

true
false

Basic Registration​

Title: Basic Registration

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: A registration secret for Basic auth. This registration is only required if functions do not have the authenticating URL.

PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ authUrlNostringNo-Auth URL

Example: Basic Login​

{
"authUrl": "https://acme.app/auth"
}

1. Property Basic Registration > authUrl​

Title: Auth URL

Typestring
RequiredYes
Formaturi

Description: The URL used for authenticating the username and password.

Restrictions
Min length1

Token Registration​

Title: Token Registration

Typeobject
RequiredNo
Additional propertiesNot allowed

Description: A registration secret for Token based auth. This registration is only required if functions do not have the authenticating URL.

PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ authUrlNostringNo-Auth URL

Example: Token​

{
"authUrl": "https://acme.app/auth"
}

1. Property Token Registration > authUrl​

Title: Auth URL

Typestring
RequiredYes
Formaturi

Description: The URL used for authenticating the token.

Restrictions
Min length1