S/MIME 証明書の管理

Gmail S/MIME API を使用すると、プログラムでアクセスして、ドメイン内のユーザーの S/MIME メール証明書を管理できます。 Google Workspace

証明書を有効にするには、管理者がドメインの S/MIME を有効にする必要があります。

S/MIME 標準では、MIME データの公開鍵の暗号化と署名の仕様が規定されています。ユーザーのアカウントで S/MIME 証明書を設定すると、Gmail はその証明書を次のように使用します。

• Gmail はユーザーの証明書と秘密鍵を使用して送信メールに署名します。
• Gmail はユーザーの秘密鍵を使用して受信メールを復号します。
• Gmail では受信者の証明書と公開鍵を使用して送信メールを暗号化します。
• Gmail は、送信者の証明書と公開鍵を使用して受信メールを確認します。

S/MIME 証明書を個別に生成し、API を使用してアップロードします。各 S/MIME 証明書は、ユーザーのメール アカウントの特定のエイリアス用です。エイリアスには、メインのメールアドレスとカスタムの「差出人」アドレスが含まれます。 1 つの S/MIME 証明書が各エイリアスのデフォルトとしてマークされます。

API アクセスの承認

API へのアクセスの承認には、次の 2 つの形式があります。

1. ドメイン全体の権限の委任でサービス アカウントを使用できます。これらの用語の説明については、認証と認可の概要の用語をご覧ください。このオプションを有効にする方法については、ドメイン全体の権限委任を使用してサービス アカウントを作成するをご覧ください。
2. OAuth2 アクセス トークンを取得するためにエンドユーザーの同意を求める標準の OAuth2 フローを使用できます。詳しくは、認証と認可の概要をご覧ください。このオプションを使用するには、ドメイン管理者がドメイン コントロール パネルで [S/MIME API エンドユーザー アクセスを有効にする] チェックボックスをオンにする必要があります。

ACL スコープ

この API は、Gmail sendAs メソッドと同じ ACL スコープに依存しています。

gmail.settings.basic

このスコープは、プライマリ SendAs S/MIME を更新するために必要です。

gmail.settings.sharing

このスコープは、カスタムの S/MIME から更新するために必要です。

API の使用

users.settings.sendAs.smimeInfo リソースは、S/MIME 証明書の管理に使用するメソッドを提供します。各証明書は、ユーザーの 1 つの送信元エイリアスに関連付けられます。

注: ユーザーの送信元エイリアスを確認するには、sendAs.list() メソッドを使用します。

S/MIME キーをアップロードする

ユーザーのエイリアスの新しい S/MIME キーをアップロードするには、smimeInfo.insert() メソッドを使用します。ターゲット エイリアスは、次のパラメータを使用して指定します。

userId

ユーザーのメールアドレス。特別な値 me を使用して、現在認証されているユーザーを示すことができます。

sendAsEmail

鍵をアップロードするエイリアス。これは、このエイリアスを使用して送信されたメールの「From:」ヘッダーに表示されるメールアドレスです。

S/MIME 証明書と秘密鍵は、その形式で pkcs12 フィールドに存在する必要があります。他のフィールドはリクエストに含めないでください。PKCS12 フィールドには、ユーザーの S/MIME 鍵と署名証明書チェーンの両方が含まれている必要があります。API はこのフィールドを受け入れる前に標準検証を実行し、次のことを検証します。

• 件名が、指定したメールアドレスと一致する。
• 有効期限は有効です。
• 発行元の認証局（CA）が Google の信頼できるリストに登録されている。
• 証明書が Gmail の技術的な制約と一致している。

鍵が暗号化されている場合、パスワードは encryptedKeyPassword フィールドに入力する必要があります。insert() の呼び出しが成功すると、smimeInfo の ID が返されます。この ID は、後でキーの参照に使用できます。

ユーザーの S/MIME キーを一覧表示する

指定されたエイリアスについて、指定されたユーザーの S/MIME キーのリストを返すには、smimeInfo.list() メソッドを使用します。ターゲット エイリアスは、次のパラメータを使用して指定します。

userId

ユーザーのメールアドレス。特別な値 me を使用して、現在認証されているユーザーを示すことができます。

sendAsEmail

キーを一覧表示するエイリアス。これは、このエイリアスを使用して送信されたメールの「From:」ヘッダーに表示されるメールアドレスです。

鍵は pem 形式でのみ返されます。鍵には S/MIME 証明書のみが含まれ、秘密鍵は含まれません。

エイリアスの S/MIME キーを取得する

smimeInfo.get() メソッドを使用して、ユーザーの特定の送信元エイリアスの特定の S/MIME キーを返します。ターゲット エイリアスは、次のパラメータを使用して指定します。

userId

ユーザーのメールアドレス。特別な値 me を使用して、現在認証されているユーザーを示すことができます。

sendAsEmail

キーを取得するエイリアス。これは、このエイリアスを使用して送信されたメールの「From:」ヘッダーに表示されるメールアドレスです。

鍵は pem 形式でのみ返されます。鍵には S/MIME 証明書のみが含まれ、秘密鍵は含まれません。

S/MIME キーを削除する

smimeInfo.delete() メソッドを使用して、指定した S/MIME キーをエイリアスから削除します。ターゲット エイリアスは、次のパラメータを使用して指定します。

userId

ユーザーのメールアドレス。特別な値 me を使用して、現在認証されているユーザーを示すことができます。

sendAsEmail

キーを取得するエイリアス。これは、このエイリアスを使用して送信されたメールの「From:」ヘッダーに表示されるメールアドレスです。

id

SmimeInfo の不変の ID。

削除された鍵は表示または使用できなくなり、対応する公開鍵で暗号化された受信した S/MIME メールは復号できません。したがって、鍵を削除する前に、その発行機関（CA）で鍵を取り消すことをおすすめします。

エイリアスのデフォルトの S/MIME キーを設定する

smimeInfo.setDefault() メソッドを使用して、指定した S/MIME キーを、指定したエイリアスのデフォルトとして指定します。ターゲット エイリアスは、次のパラメータを使用して指定します。

userId

ユーザーのメールアドレス。特別な値 me を使用して、現在認証されているユーザーを示すことができます。

sendAsEmail

キーを取得するエイリアス。これは、このエイリアスを使用して送信されたメールの「From:」ヘッダーに表示されるメールアドレスです。

id

SmimeInfo の不変の ID。

ユーザーの SendAs デフォルトで使用される S/MIME キーは 1 つのみです。setDefault() を呼び出すと、以前のデフォルトは設定解除されます。

Gmail は、特定の鍵で署名された S/MIME メッセージを受信すると、その鍵に関連付けられたユーザー宛てのメールを暗号化する際のデフォルトとして、not_before 有効期限に現在より先の日付が関連付けられます。ユーザーがすでにやり取りしている Gmail ユーザーが新しいデフォルトの鍵を使用するようにするには、新しいデフォルトの鍵の not_before の日付を以前のデフォルトの鍵より後に設定するか、以前のデフォルトの鍵を取り消します。

サンプルコード

次のコードサンプルは、複数のユーザーが存在する組織で API を使用して S/MIME 証明書を管理する方法を示しています。

S/MIME 証明書用の SmimeInfo リソースの作成

次のコードサンプルでは、ファイルから証明書を読み取り、base64url 文字列にエンコードして、smimeInfo リソースの pkcs12 フィールドに割り当てる方法を示します。

Java

gmail/snippets/src/main/java/CreateSmimeInfo.java

GitHub で表示

import com.google.api.services.gmail.model.SmimeInfo;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Base64;

/* Class to demonstrate the use of Gmail Create SmimeInfo API */
public class CreateSmimeInfo {
  /**
   * Create an SmimeInfo resource for a certificate from file.
   *
   * @param filename Name of the file containing the S/MIME certificate.
   * @param password Password for the certificate file, or null if the file is not
   *                 password-protected.
   * @return An SmimeInfo object with the specified certificate.
   */
  public static SmimeInfo createSmimeInfo(String filename, String password) {
    SmimeInfo smimeInfo = null;
    InputStream in = null;

    try {
      File file = new File(filename);
      in = new FileInputStream(file);
      byte[] fileContent = new byte[(int) file.length()];
      in.read(fileContent);

      smimeInfo = new SmimeInfo();
      smimeInfo.setPkcs12(Base64.getUrlEncoder().encodeToString(fileContent));
      if (password != null && password.length() > 0) {
        smimeInfo.setEncryptedKeyPassword(password);
      }
    } catch (Exception e) {
      System.out.printf("An error occured while reading the certificate file: %s\n", e);
    } finally {
      try {
        if (in != null) {
          in.close();
        }
      } catch (IOException ioe) {
        System.out.printf("An error occured while closing the input stream: %s\n", ioe);
      }
    }
    return smimeInfo;
  }
}

Python

gmail/snippet/smimesnippet/create_smime_info.py

GitHub で表示

import base64


def create_smime_info(cert_filename, cert_password):
  """Create an smimeInfo resource for a certificate from file.
  Args:
    cert_filename: Name of the file containing the S/MIME certificate.
    cert_password: Password for the certificate file, or None if the file is not
        password-protected.
  Returns : Smime object, including smime information
  """

  smime_info = None
  try:
    with open(cert_filename, "rb") as cert:
      smime_info = {}
      data = cert.read().encode("UTF-8")
      smime_info["pkcs12"] = base64.urlsafe_b64encode(data).decode()
      if cert_password and len(cert_password) > 0:
        smime_info["encryptedKeyPassword"] = cert_password

  except (OSError, IOError) as error:
    print(f"An error occurred while reading the certificate file: {error}")
    smime_info = None

  return smime_info


if __name__ == "__main__":
  print(create_smime_info(cert_filename="xyz", cert_password="xyz"))

S/MIME 証明書のアップロード

証明書をアップロードするには、smimeInfo.insert を呼び出し、リクエストの本文で smimeInfo リソースを指定します。

Java

gmail/snippets/src/main/java/InsertSmimeInfo.java

GitHub で表示

import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.gmail.Gmail;
import com.google.api.services.gmail.GmailScopes;
import com.google.api.services.gmail.model.SmimeInfo;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;

/* Class to demonstrate the use of Gmail Insert Smime Certificate API*/
public class InsertSmimeInfo {
  /**
   * Upload an S/MIME certificate for the user.
   *
   * @param userId      User's email address.
   * @param sendAsEmail The "send as" email address, or null if it should be the same as userId.
   * @param smimeInfo   The SmimeInfo object containing the user's S/MIME certificate.
   * @return An SmimeInfo object with details about the uploaded certificate, {@code null} otherwise.
   * @throws IOException - if service account credentials file not found.
   */
  public static SmimeInfo insertSmimeInfo(String userId,
                                          String sendAsEmail,
                                          SmimeInfo smimeInfo)
      throws IOException {
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(GmailScopes.GMAIL_SETTINGS_SHARING);
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Create the gmail API client
    Gmail service = new Gmail.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Gmail samples")
        .build();

    if (sendAsEmail == null) {
      sendAsEmail = userId;
    }

    try {
      SmimeInfo results = service.users().settings().sendAs().smimeInfo()
          .insert(userId, sendAsEmail, smimeInfo)
          .execute();
      System.out.printf("Inserted certificate, id: %s\n", results.getId());
      return results;
    } catch (IOException e) {
      System.err.printf("An error occured: %s", e);
    }
    return null;
  }
}

Python

gmail/snippet/smimesnippet/insert_smime_info.py

GitHub で表示

import create_smime_info
import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def insert_smime_info():
  """Upload an S/MIME certificate for the user.
  Print the inserted certificate's id
  Returns : Result object with inserted certificate id and other meta-data

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()

  try:
    # create gmail api client
    service = build("gmail", "v1", credentials=creds)

    user_id = "[e-mail]"
    smime_info = create_smime_info.create_smime_info(
        cert_filename="xyz", cert_password="xyz"
    )
    send_as_email = None

    if not send_as_email:
      send_as_email = user_id

    # pylint: disable=maybe-no-member
    results = (
        service.users()
        .settings()
        .sendAs()
        .smimeInfo()
        .insert(userId=user_id, sendAsEmail=send_as_email, body=smime_info)
        .execute()
    )
    print(f'Inserted certificate; id: {results["id"]}')

  except HttpError as error:
    print(f"An error occurred: {error}")
    results = None

  return results


if __name__ == "__main__":
  insert_smime_info()

多数のユーザーの証明書を管理する例

組織内の多数のユーザーの証明書をまとめて管理することもできます。 次の例は、1 回のバッチ呼び出しで複数のユーザーの証明書を管理する方法を示しています。

CSV ファイルからの証明書の挿入

ユーザー ID と各ユーザーの証明書へのパスがリストされた CSV ファイルがあるとします。

$ cat certificates.csv
[e-mail],/path/to/user1_cert.p12,cert_password_1
[e-mail],/path/to/user2_cert.p12,cert_password_2
[e-mail],/path/to/user3_cert.p12,cert_password_3

Java

前述の createSmimeInfo と insertSmimeInfo の呼び出しを使用して、CSV ファイルで指定されている証明書をアップロードできます。

gmail/snippets/src/main/java/InsertCertFromCsv.java

GitHub で表示

import com.google.api.services.gmail.model.SmimeInfo;
import java.io.File;
import org.apache.commons.csv.CSVFormat;
import org.apache.commons.csv.CSVParser;
import org.apache.commons.csv.CSVRecord;

/* Class to demonstrate the use of Gmail Insert Certificate from CSV File */
public class InsertCertFromCsv {
  /**
   * Upload S/MIME certificates based on the contents of a CSV file.
   *
   * <p>Each row of the CSV file should contain a user ID, path to the certificate, and the
   * certificate password.
   *
   * @param csvFilename Name of the CSV file.
   */
  public static void insertCertFromCsv(String csvFilename) {
    try {
      File csvFile = new File(csvFilename);
      CSVParser parser =
          CSVParser.parse(csvFile, java.nio.charset.StandardCharsets.UTF_8, CSVFormat.DEFAULT);
      for (CSVRecord record : parser) {
        String userId = record.get(0);
        String certFilename = record.get(1);
        String certPassword = record.get(2);
        SmimeInfo smimeInfo = CreateSmimeInfo.createSmimeInfo(certFilename,
            certPassword);
        if (smimeInfo != null) {
          InsertSmimeInfo.insertSmimeInfo(userId,
              userId,
              smimeInfo);
        } else {
          System.err.printf("Unable to read certificate file for userId: %s\n", userId);
        }
      }
    } catch (Exception e) {
      System.err.printf("An error occured while reading the CSV file: %s", e);
    }
  }
}

Python

前述の create_smime_info と insert_smime_info の呼び出しを使用して、CSV ファイルで指定されている証明書をアップロードできます。

gmail/snippet/smimesnippet/insert_cert_from_csv.py

GitHub で表示

import csv

import create_smime_info
import insert_smime_info


def insert_cert_from_csv(csv_filename):
  """Upload S/MIME certificates based on the contents of a CSV file.
  Each row of the CSV file should contain a user ID, path to the certificate,
  and the certificate password.

  Args:
    csv_filename: Name of the CSV file.
  """

  try:
    with open(csv_filename, "rb") as cert:
      csv_reader = csv.reader(cert, delimiter=",")
      next(csv_reader, None)  # skip CSV file header
      for row in csv_reader:
        user_id = row[0]
        cert_filename = row[1]
        cert_password = row[2]
        smime_info = create_smime_info.create_smime_info(
            cert_filename=cert_filename, cert_password=cert_password
        )
        if smime_info:
          insert_smime_info.insert_smime_info()
        else:
          print(f"Unable to read certificate file for user_id: {user_id}")
        return smime_info

  except (OSError, IOError) as error:
    print(f"An error occured while reading the CSV file: {error}")


if __name__ == "__main__":
  insert_cert_from_csv(csv_filename="xyz")

証明書の管理

この例では、smimeInfo API からの複数の呼び出しを組み合わせて、組織の証明書の管理方法を示します。ユーザーの証明書が一覧表示されます。デフォルトの証明書が期限切れになっているか未設定の場合は、指定されたファイルにある証明書をアップロードします。次に、有効期限が最も遠い証明書をデフォルトとして設定します。

その後、前の例と同様に CSV ファイルを処理する関数から呼び出されます。

Java

gmail/snippets/src/main/java/UpdateSmimeCerts.java

GitHub で表示

import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.gmail.Gmail;
import com.google.api.services.gmail.GmailScopes;
import com.google.api.services.gmail.model.ListSmimeInfoResponse;
import com.google.api.services.gmail.model.SmimeInfo;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.IOException;
import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneId;

/* Class to demonstrate the use of Gmail Update Smime Certificate API*/
public class UpdateSmimeCerts {
  /**
   * Update S/MIME certificates for the user.
   *
   * <p>First performs a lookup of all certificates for a user. If there are no certificates, or
   * they all expire before the specified date/time, uploads the certificate in the specified file.
   * If the default certificate is expired or there was no default set, chooses the certificate with
   * the expiration furthest into the future and sets it as default.
   *
   * @param userId       User's email address.
   * @param sendAsEmail  The "send as" email address, or None if it should be the same as user_id.
   * @param certFilename Name of the file containing the S/MIME certificate.
   * @param certPassword Password for the certificate file, or None if the file is not
   *                     password-protected.
   * @param expireTime   DateTime object against which the certificate expiration is compared. If
   *                     None, uses the current time. @ returns: The ID of the default certificate.
   * @return The ID of the default certificate, {@code null} otherwise.
   * @throws IOException - if service account credentials file not found.
   */
  public static String updateSmimeCerts(String userId,
                                        String sendAsEmail,
                                        String certFilename,
                                        String certPassword,
                                        LocalDateTime expireTime)
      throws IOException {
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
            guides on implementing OAuth2 for your application. */
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(GmailScopes.GMAIL_SETTINGS_SHARING);
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Create the gmail API client
    Gmail service = new Gmail.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Gmail samples")
        .build();

    if (sendAsEmail == null) {
      sendAsEmail = userId;
    }

    ListSmimeInfoResponse listResults;
    try {
      listResults =
          service.users().settings().sendAs().smimeInfo().list(userId, sendAsEmail).execute();
    } catch (IOException e) {
      System.err.printf("An error occurred during list: %s\n", e);
      return null;
    }

    String defaultCertId = null;
    String bestCertId = null;
    LocalDateTime bestCertExpire = LocalDateTime.MIN;

    if (expireTime == null) {
      expireTime = LocalDateTime.now();
    }
    if (listResults != null && listResults.getSmimeInfo() != null) {
      for (SmimeInfo smimeInfo : listResults.getSmimeInfo()) {
        String certId = smimeInfo.getId();
        boolean isDefaultCert = smimeInfo.getIsDefault();
        if (isDefaultCert) {
          defaultCertId = certId;
        }
        LocalDateTime exp =
            LocalDateTime.ofInstant(
                Instant.ofEpochMilli(smimeInfo.getExpiration()), ZoneId.systemDefault());
        if (exp.isAfter(expireTime)) {
          if (exp.isAfter(bestCertExpire)) {
            bestCertId = certId;
            bestCertExpire = exp;
          }
        } else {
          if (isDefaultCert) {
            defaultCertId = null;
          }
        }
      }
    }
    if (defaultCertId == null) {
      String defaultId = bestCertId;
      if (defaultId == null && certFilename != null) {
        SmimeInfo smimeInfo = CreateSmimeInfo.createSmimeInfo(certFilename,
            certPassword);
        SmimeInfo insertResults = InsertSmimeInfo.insertSmimeInfo(userId,
            sendAsEmail,
            smimeInfo);
        if (insertResults != null) {
          defaultId = insertResults.getId();
        }
      }

      if (defaultId != null) {
        try {
          service.users().settings().sendAs().smimeInfo().setDefault(userId, sendAsEmail, defaultId)
              .execute();
          return defaultId;
        } catch (IOException e) {
          System.err.printf("An error occured during setDefault: %s", e);
        }
      }
    } else {
      return defaultCertId;
    }

    return null;
  }
}

Python

gmail/snippet/smimesnippet/update_smime_cert.py

GitHub で表示

from datetime import datetime

import create_smime_info
import google.auth
import insert_smime_info
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError


def update_smime_cert(
    user_id, send_as_email, cert_filename, cert_password, expire_dt
):
  """Update S/MIME certificates for the user.

  First performs a lookup of all certificates for a user.  If there are no
  certificates, or they all expire before the specified date/time, uploads the
  certificate in the specified file.  If the default certificate is expired or
  there was no default set, chooses the certificate with the expiration furthest
  into the future and sets it as default.

  Args:
    user_id: User's email address.
    send_as_email: The "send as" email address, or None if it should be the same
        as user_id.
    cert_filename: Name of the file containing the S/MIME certificate.
    cert_password: Password for the certificate file, or None if the file is not
        password-protected.
    expire_dt: DateTime object against which the certificate expiration is
      compared.  If None, uses the current time.

  Returns:
    The ID of the default certificate.

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  if not send_as_email:
    send_as_email = user_id

  creds, _ = google.auth.default()

  try:
    # create gmail api client
    service = build("gmail", "v1", credentials=creds)

    # pylint: disable=maybe-no-member
    results = (
        service.users()
        .settings()
        .sendAs()
        .smimeInfo()
        .list(userId=user_id, sendAsEmail=send_as_email)
        .execute()
    )

  except HttpError as error:
    print(f"An error occurred during list: {error}")
    return None

  default_cert_id = None
  best_cert_id = (None, datetime.datetime.fromtimestamp(0))

  if not expire_dt:
    expire_dt = datetime.datetime.now()
  if results and "smimeInfo" in results:
    for smime_info in results["smimeInfo"]:
      cert_id = smime_info["id"]
      is_default_cert = smime_info["isDefault"]
      if is_default_cert:
        default_cert_id = cert_id
      exp = datetime.datetime.fromtimestamp(smime_info["expiration"] / 1000)
      if exp > expire_dt:
        if exp > best_cert_id[1]:
          best_cert_id = (cert_id, exp)
      else:
        if is_default_cert:
          default_cert_id = None

  if not default_cert_id:
    default_id = best_cert_id[0]
    if not default_id and cert_filename:
      create_smime_info.create_smime_info(
          cert_filename=cert_filename, cert_password=cert_password
      )
      results = insert_smime_info.insert_smime_info()
      if results:
        default_id = results["id"]

    if default_id:
      try:
        # pylint: disable=maybe-no-member
        service.users().settings().sendAs().smimeInfo().setDefault(
            userId=user_id, sendAsEmail=send_as_email, id=default_id
        ).execute()
        return default_id
      except HttpError as error:
        print(f"An error occurred during setDefault: {error}")
  else:
    return default_cert_id

  return None


if __name__ == "__main__":
  update_smime_cert(
      user_id="xyz",
      send_as_email=None,
      cert_filename="xyz",
      cert_password="xyz",
      expire_dt=None,
  )