C3 AI Documentation Home

Authentication mechanisms in the C3 Agentic AI Platform

Various services or connections may require different authentication methods. To specify the authentication mechanism supported by the service or connection, use the AuthenticationKind Type.

The options in the AuthenticationKind Type allow the C3 Agentic AI Platform to determine which method to use to authenticate and authorize requests correctly.

AuthenticationKind options

The AuthenticationKind Type lists the following authentication mechanisms and their purposes:

Auth mechanismPurpose
BasicAuthentication with username and password
TESTAuthentication with test identity provider
C3_REGISTRATIONAuthentication for registration with C3 Agentic AI Platform
SAMLAuthentication with Security Assertion Markup Language (SAML)
OIDCAuthentication with OpenID Connect (OIDC)
OIDC_DIRECT_LOGINAuthentication with OpenID Connect (OIDC) direct login
LDAPAuthentication with Lightweight Directory Access Protocol (LDAP)
SESSIONAuthentication using session token
c3appAuthentication using application token
undefinedUndefined authorization header
c3Authentication with c3auth set in cookie
c3keyAuthentication with public private key pair
BearerAuthentication with OAuth token
C3-Action-Auth-Action authentication for callback from external process
c3clusterAuthentication with cluster public key and private key pair
C3BearerAuthentication for C3 AI APIs
c3oauthcodeAuthentication with OAuth C3 AI authorization code
c3oauthrefreshOAuth authentication with C3 AI refresh token
c3oauthccOAuth C3 AI authentication with client credentials grant type
k8sauthAuthentication with Kubernetes token

Example uses

Here are some example requests using AuthenticationKind authentication methods.

OAuth authentication

For services or connections that support OAuth, use Bearer with an OAuth token in the request authorization header. For example:

Text
curl \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-X GET \
https://<cluster>/<environment>/<app>/api/8/User/myUser

C3 AI Agentic AI Platform authentication

For services or connections that support C3 Agentic AI Platform authentication or c3auth, use C3Bearer with an authentication token in the request authorization header. For example:

Text
curl \
-H "Authorization: C3Bearer <token>" \
-H "Content-Type: application/json" \
-X GET \
https://your-c3-app-url/api/8/YourType/yourEndpoint

See also

Was this page helpful?