Skip to content

CodePipelineOAuthCredentials

A coding tool’s sign-in (OAuth tokens from a subscription) for a code pipeline engine, used in place of an API key.

Kind: an object, used in requests and responses. In a request it is called CodePipelineOAuthCredentialsInput.

FieldTypeRequiredDescription
accessTokenstringThe OAuth access token. Write-only: never returned.
refreshTokenstringThe OAuth refresh token. Write-only: never returned.
idTokenstring | nullThe OpenID Connect ID token, for coding tools that need it alongside the access and refresh tokens (Codex does; Claude Code doesn’t). Write-only: never returned.
expiresAtdatetimeWhen the access token expires, in UTC.
scopesstring[] | nullThe scopes the tokens were granted.
oAuthSubscriptionTypestring | nullThe subscription plan the sign-in belongs to (for example a Claude subscription tier), as the provider names it.
engineCodeEngineTypeThe engine this credential is for.
credentialIdstring | nullYour id for this credential. The run records it on the tokens the credential used (tokenUsage) and, when your own credential fails, in credentialFailures, so you can tell which key did what.
isOwnLicensebooleanTrue for your own key or sign-in, which you pay the provider for. False marks a fallback to Maitento’s own key: leave its apiKey empty. Its use counts as platform usage, and your tenant can forbid it.
priorityinteger | nullThe order to try this engine’s credentials in: lower first. Null: after the numbered ones.
billingModestring | nullThe kind of plan the credential is on with its provider (for example SubscriptionPlan or PayAsYouGoApi), recorded for reporting. Null when not given.
{
"accessToken": "...",
"refreshToken": "...",
"idToken": "...",
"expiresAt": "2026-10-26T12:00:00.0000000Z",
"scopes": [
"..."
],
"oAuthSubscriptionType": "...",
"engine": "Claude",
"credentialId": "...",
"isOwnLicense": false,
"priority": 0,
"billingMode": "..."
}

Every field is present in a response; empty ones are null.

FieldTypeDescription
expiresAtdatetimeWhen the access token expires, in UTC.
scopesstring[] | nullThe scopes the tokens were granted.
oAuthSubscriptionTypestring | nullThe subscription plan the sign-in belongs to (for example a Claude subscription tier), as the provider names it.
engineCodeEngineTypeThe engine this credential is for.
credentialIdstring | nullYour id for this credential. The run records it on the tokens the credential used (tokenUsage) and, when your own credential fails, in credentialFailures, so you can tell which key did what.
isOwnLicensebooleanTrue for your own key or sign-in, which you pay the provider for. False marks a fallback to Maitento’s own key: leave its apiKey empty. Its use counts as platform usage, and your tenant can forbid it.
priorityinteger | nullThe order to try this engine’s credentials in: lower first. Null: after the numbered ones.
billingModestring | nullThe kind of plan the credential is on with its provider (for example SubscriptionPlan or PayAsYouGoApi), recorded for reporting. Null when not given.
{
"expiresAt": "2026-10-26T12:00:00.0000000Z",
"scopes": [
"..."
],
"oAuthSubscriptionType": "...",
"engine": "Claude",
"credentialId": "...",
"isOwnLicense": false,
"priority": 0,
"billingMode": "..."
}