NamedCredentials クラス

API バージョン

56.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Credential createCredential(ConnectApi.CredentialInput requestBody)

パラメーター

requestBody

型: ConnectApi.CredentialInput

ConnectApi.CredentialInput クラス。

戻り値

型: ConnectApi.Credential

API バージョン

58.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Credential createCredential(ConnectApi.CredentialInput requestBody, ConnectApi.CreateCredentialAction action)

パラメーター

requestBody

型: ConnectApi.CredentialInput

ConnectApi.CredentialInput クラス。

action

型: ConnectApi.CreateCredentialAction

ログイン情報の作成時に実行するアクション。値は次のとおりです。

• Refresh

戻り値

型: ConnectApi.Credential

API バージョン

58.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ExternalCredential createExternalCredential(ConnectApi.ExternalCredentialInput requestBody)

パラメーター

requestBody

型: ConnectApi.ExternalCredentialInput

外部ログイン情報を作成または更新するために使用される入力。

戻り値

型: ConnectApi.ExternalCredential

API バージョン

58.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.NamedCredential createNamedCredential(ConnectApi.NamedCredentialInput requestBody)

パラメーター

requestBody

型: ConnectApi.NamedCredentialInput

指定ログイン情報を作成または更新するために使用される入力。

戻り値

型: ConnectApi.NamedCredential

API バージョン

56.0

Chatter が必要かどうか

いいえ

署名

public static Void deleteCredential(String externalCredential, String principalName, ConnectApi.CredentialPrincipalType principalType)

パラメーター

externalCredential

型: String

外部ログイン情報の完全修飾開発者名。

principalName

型: String

外部ログイン情報の指定ユーザーの名前。

principalType

型: ConnectApi.CredentialPrincipalType

ログイン情報のユーザーの種別。値は次のとおりです。

• AwsStsPrincipal
• NamedPrincipal
• PerUserPrincipal

戻り値

型: Void

API バージョン

59.0

Chatter が必要かどうか

いいえ

署名

public static Void deleteCredential(String externalCredential, String principalName, ConnectApi.CredentialPrincipalType principalType, List<String> authenticationParameters)

パラメーター

externalCredential

型: String

外部ログイン情報の完全修飾開発者名。

principalName

型: String

外部ログイン情報の指定ユーザーの名前。

principalType

型: ConnectApi.CredentialPrincipalType

ログイン情報のユーザーの種別。値は次のとおりです。

• AwsStsPrincipal
• NamedPrincipal
• PerUserPrincipal

authenticationParameters

型: List<String>

カスタムプロトコル専用の認証パラメーターのリスト (例: myApiKey,myApiSecret)。指定されていない場合、すべてのログイン情報が削除されます。

戻り値

型: Void

API バージョン

56.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Credential getCredential(String externalCredential, String principalName, ConnectApi.CredentialPrincipalType principalType)

パラメーター

externalCredential

型: String

外部ログイン情報の完全修飾開発者名。

principalName

型: String

外部ログイン情報の指定ユーザーの名前。

principalType

型: ConnectApi.CredentialPrincipalType

ログイン情報のユーザーの種別。値は次のとおりです。

• AwsStsPrincipal
• NamedPrincipal
• PerUserPrincipal

戻り値

型: ConnectApi.Credential

API バージョン

56.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ExternalCredential getExternalCredential(String developerName)

パラメーター

developerName

型: String

外部ログイン情報の完全修飾開発者名。

戻り値

型: ConnectApi.ExternalCredential

API バージョン

56.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.ExternalCredentialList getExternalCredentials()

戻り値

型: ConnectApi.ExternalCredentialList

API バージョン

59.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.NamedCredential getNamedCredential(String developerName)

パラメーター

developerName

型: String

指定ログイン情報の完全修飾開発者名。

戻り値

型: ConnectApi.NamedCredential

API バージョン

59.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.NamedCredentialList getNamedCredentials()

戻り値

型: ConnectApi.NamedCredentialList

API バージョン

56.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.OAuthCredentialAuthUrl getOAuthCredentialAuthUrl(ConnectApi.OAuthCredentialAuthUrlInput requestBody)

パラメーター

requestBody

型: ConnectApi.OAuthCredentialAuthUrlInput

OAuth 認証フローを示す ConnectApi.OAuthCredentialAuthUrlInput クラス。

戻り値

型: ConnectApi.OAuthCredentialAuthUrl

使用方法

特定の外部ログイン情報と必要に応じて指定ユーザーを表す入力パラメーターを受け入れます。認証フローを開始し、最終的には Salesforce に認証トークンを返すためにユーザーがアクセスする必要がある URL を返します。このメソッドは、カスタマイズまたはブランド設定されたユーザーインターフェースを作成し、ユーザーが認証を開始できるようにする手順の一環として使用します。

例

1ConnectApi.OAuthCredentialAuthUrlInput input = new ConnectApi.OAuthCredentialAuthUrlInput();
2
3input.externalCredential = 'MyExternalCredentialDeveloperName';
4input.principalType = ConnectApi.CredentialPrincipalType.PerUserPrincipal;
5input.principalName = 'MyPrincipal'; // Only required when principalType = NamedPrincipal
6
7ConnectApi.OAuthCredentialAuthUrl output = ConnectApi.NamedCredentials.getOAuthCredentialAuthUrl(input);
8
9String authenticationUrl = output.authenticationUrl; // Redirect users to this URL to authenticate in the browser

このメソッドはカスタムログイン情報を更新します。ログイン情報を置換するには、updateCredential(requestBody) を使用します。

API バージョン

59.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Credential patchCredential(ConnectApi.CredentialInput requestBody)

パラメーター

requestBody

型: ConnectApi.CredentialInput

ConnectApi.CredentialInput クラス。入力クラスのカスタムログイン情報のみが更新されます。

戻り値

型: ConnectApi.Credential

このメソッドはログイン情報を置換します。ログイン情報を更新するには、patchCredential(requestBody) を使用します。

API バージョン

56.0

Chatter が必要かどうか

いいえ

署名

public static ConnectApi.Credential updateCredential(ConnectApi.CredentialInput requestBody)

パラメーター

requestBody

型: ConnectApi.CredentialInput

ConnectApi.CredentialInput クラス。

戻り値

型: ConnectApi.Credential