Skip to main content

OAuthCodeCredentials

############################################################### OAUTH2 CODE ###############################################################

type OAuthCodeCredentials implements CredentialsBase {
id: ID!
key: String
shared: Boolean!
canDecrypt: Boolean
system: MonitoredSystem
purpose: CredentialsPurpose
name: String
clientId: String
clientSecret: String
authorizationUri: String
accessTokenUri: String
accessToken: String
refreshToken: String
expirationDateInMillis: Int
redirectUri: String
scope: String
parameters: [Property]
}

Fields

OAuthCodeCredentials.id ● ID! non-null scalar

This credentials ID

OAuthCodeCredentials.key ● String scalar

Identifies to credentials with a purpose and should be used in set... and delete.. credential operations.

OAuthCodeCredentials.shared ● Boolean! non-null scalar

The shared flag (true for global credentials)

OAuthCodeCredentials.canDecrypt ● Boolean scalar

OAuthCodeCredentials.system ● MonitoredSystem interface

If there is a monitored system associated this field can return it.

OAuthCodeCredentials.purpose ● CredentialsPurpose object

The purpose of this credentials.

OAuthCodeCredentials.name ● String scalar

The name of this credentials object.

OAuthCodeCredentials.clientId ● String scalar

The client ID.

OAuthCodeCredentials.clientSecret ● String scalar

The client secret.

OAuthCodeCredentials.authorizationUri ● String scalar

An authorization URI.

OAuthCodeCredentials.accessTokenUri ● String scalar

An URI to generate the access tokens with the authorization token.

OAuthCodeCredentials.accessToken ● String scalar

The access token.

OAuthCodeCredentials.refreshToken ● String scalar

A potential refresh token.

OAuthCodeCredentials.expirationDateInMillis ● Int scalar

Expiration time in milliseconds.

OAuthCodeCredentials.redirectUri ● String scalar

A redirection URI.

OAuthCodeCredentials.scope ● String scalar

String containing all the needed scopes.

OAuthCodeCredentials.parameters ● [Property] list object

Additional parameters.

Interfaces

CredentialsBase interface

Member Of

CreateOAuthCodeCredentialsPayload object ● SetOAuthCodeCredentialsPayload object ● UpdateOAuthCodeCredentialsPayload object