createFederated static method

Creates a TokenCredential to access a secured federated ArcGIS resource.

Federation is a security and administrative configuration in which an ArcGIS Server is registered with an ArcGIS Enterprise portal or ArcGIS Online organization, delegating authentication and authorization to the portal. This allows the portal to manage user identities, roles, and permissions for the server's services.

This method creates a credential for a service directly using an existing portal credential, without relying on an authentication challenge or re-entering user credentials.

• A valid portal credential is required to create a federated token credential.
• Allows any ArcGISCredential type to be used as the portal credential.
• If a portal credential is not provided and the ArcGISCredentialStore does not contain a credential for the federating portal, an error of type ArcGISExceptionType.authenticationPortalCredentialMissing is returned.
• If the provided portal credential does not match the portal with which the server is federated, an error of type ArcGISExceptionType.authenticationCredentialCannotBeShared is returned.
• If the provided URL is not federated with any portal, an error of type ArcGISExceptionType.authenticationServiceNotFederated is returned.

Parameters:

• uri — The URL of the token-secured federated resource.
• portalCredential — A credential for the portal with which the server hosting URL is federated. If not provided, the method retrieves one from ArcGISCredentialStore. If none is available, the creation of the federated credential will fail.
• tokenExpirationInterval — The requested token validity duration, in minutes. If this value is less than or equal to zero, it defaults to the portal credential's token expiration interval. The server may shorten the requested duration based on its maximum token lifetime settings.

Return Value: A TokenCredential.