webCredential - APEXlang Reference

`webCredential`

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	Yes		data type=`string`; maxLen=255 Enter a descriptive name for the Credentials. This name must be unique within the workspace.
`type`	`enum`	Yes	`basicAuthentication`	data type=`string`; lov=`STATIC` Valid values: `basicAuthentication` `oauth2ClientCredentialsFlow` `oci` `httpHeader` `urlQueryString` `keyPair` `certificatePrivateKeyPair` `oauth2PasswordFlow` `signedUserAssertion` `userAssertionSigningCertificate`

Property Groups:

authentication

Property	Type	Required	Default Value	Details
`databaseCredentialName`	`string`	No		data type=`string`; maxLen=128 Applies when`type in (basicAuthentication)type in (oauth2ClientCredentialsFlow)type in (signedUserAssertion)type in (oauth2PasswordFlow)type in (oci)`
`instanceLevelDatabaseCredential`	`boolean`	Yes	`false`	data type=`boolean` Applies when`type in (basicAuthentication) and databaseCredentialName is settype in (oauth2ClientCredentialsFlow) and databaseCredentialName is settype in (signedUserAssertion) and databaseCredentialName is settype in (oauth2PasswordFlow) and databaseCredentialName is settype in (oci) and databaseCredentialName is set`
`oauthScope`	`string`	No		data type=`string`; maxLen=255 Applies when`type in (oauth2ClientCredentialsFlow)type in (signedUserAssertion)type in (oauth2PasswordFlow)`
`clientIdOrUsername`	`string`	No		data type=`string`; maxLen=4000 Applies when`type in (basicAuthentication)type in (basicAuthentication) and type in (oauth2ClientCredentialsFlow)type in (basicAuthentication) and type in (signedUserAssertion)type in (basicAuthentication) and type in (oauth2PasswordFlow)type in (basicAuthentication) and type in (oci)type in (oauth2ClientCredentialsFlow) and type in (basicAuthentication)type in (oauth2ClientCredentialsFlow)type in (oauth2ClientCredentialsFlow) and type in (signedUserAssertion)type in (oauth2ClientCredentialsFlow) and type in (oauth2PasswordFlow)type in (oauth2ClientCredentialsFlow) and type in (oci)type in (signedUserAssertion) and type in (basicAuthentication)type in (signedUserAssertion) and type in (oauth2ClientCredentialsFlow)type in (signedUserAssertion)type in (signedUserAssertion) and type in (oauth2PasswordFlow)type in (signedUserAssertion) and type in (oci)type in (oauth2PasswordFlow) and type in (basicAuthentication)type in (oauth2PasswordFlow) and type in (oauth2ClientCredentialsFlow)type in (oauth2PasswordFlow) and type in (signedUserAssertion)type in (oauth2PasswordFlow)type in (oauth2PasswordFlow) and type in (oci)`
`ociUserId`	`string`	No		data type=`string`; maxLen=32767 Applies when`type = oci`
`ociTenancyId`	`string`	No		data type=`string`; maxLen=4000 Applies when`type = oci`
`ociPublicKeyFingerprint`	`string`	No		data type=`string`; maxLen=4000 Applies when`type = oci`
`certificate`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Applies when`type in (certificatePrivateKeyPair)type in (userAssertionSigningCertificate)`
`publicKey`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Applies when`type = keyPair`
`audienceList`	`string`	No		data type=`string`; maxLen=32767 Applies when`type = userAssertionSigningCertificate`
`certificateAlias`	`string`	No		data type=`string`; maxLen=32767 Applies when`type = userAssertionSigningCertificate`
`credentialName`	`string`	No		data type=`string`; maxLen=4000 Applies when`type in (httpHeader)type in (urlQueryString)`

authentication {
  databaseCredentialName: value
  instanceLevelDatabaseCredential: false
  oauthScope: value
  clientIdOrUsername: value
  ociUserId: value
  ociTenancyId: value
  ociPublicKeyFingerprint: value
  certificate: ```
    value
  ```
  publicKey: ```
    value
  ```
  audienceList: value
  certificateAlias: value
  credentialName: value
}

advanced

Property	Type	Required	Default Value	Details
`validForUrls`	`multiline string`	No		data type=`multiline string`; maxLen=32767 Applies when`type in (basicAuthentication)type in (oauth2ClientCredentialsFlow)type in (signedUserAssertion)type in (oauth2PasswordFlow)type in (oci)`
`signingCredential`	`reference`	Yes		data type=`reference`; lov=`COMPONENT`; references=`webCredential` Applies when`type = signedUserAssertion`
`usernameExpression`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Applies when`type = signedUserAssertion`
`namedScopes`	`multiline string`	No		data type=`multiline string`; maxLen=32767 Applies when`type in (oauth2ClientCredentialsFlow)type in (signedUserAssertion)type in (oauth2PasswordFlow)`
`authenticationCredential`	`reference`	Yes		data type=`reference`; lov=`COMPONENT`; references=`webCredential` Applies when`type = oauth2PasswordFlow`
`tokenAuthenticationMethod`	`enum`	Yes	`basicAuthentication`	data type=`string`; lov=`STATIC` Valid values: `clientIdAndClientSecretInBody` `basicAuthentication` `basicAuthenticationAndClientIdInBody` `clientIdInBody` Applies when`type in (oauth2ClientCredentialsFlow)type in (oauth2PasswordFlow)`
`staticId`	`string`	Yes		data type=`string`; maxLen=255 Use the Static ID to reference the Credential in API Calls.
`promptOnInstall`	`boolean`	Yes	`false`	data type=`boolean` Applies when`type in (basicAuthentication)type in (oauth2ClientCredentialsFlow)type in (signedUserAssertion)type in (oauth2PasswordFlow)type in (oci)`

advanced {
  validForUrls: ```
    value
  ```
  signingCredential: @component
  usernameExpression: ```plsql
    value
  ```
  namedScopes: ```json
    value
  ```
  authenticationCredential: @component
  tokenAuthenticationMethod: clientIdAndClientSecretInBody
  staticId: value
  promptOnInstall: false
}

comments

Property	Type	Required	Default Value	Details
`comments`	`multiline string`	No		data type=`multiline string`; maxLen=4000

comments {
  comments: ```
    value
  ```
}

APEXlang Example

webCredential sample (
    name: value
    type: basicAuthentication
    authentication {
        databaseCredentialName: value
        instanceLevelDatabaseCredential: false
        oauthScope: value
        clientIdOrUsername: value
        ociUserId: value
        ociTenancyId: value
        ociPublicKeyFingerprint: value
        certificate: ```
          value
        ```
        publicKey: ```
          value
        ```
        audienceList: value
        certificateAlias: value
        credentialName: value
    }
    advanced {
        validForUrls: ```
          value
        ```
        signingCredential: @component
        usernameExpression: ```plsql
          value
        ```
        namedScopes: ```json
          value
        ```
        authenticationCredential: @component
        tokenAuthenticationMethod: clientIdAndClientSecretInBody
        staticId: value
        promptOnInstall: false
    }
    comments {
        comments: ```
          value
        ```
    }
)