Google: Gets the specified S MIME config for the specified send-as alias For more information, see Manage S MIME certificates with the Gmail API (https: developers google com workspace gmail api guides smime certs)

← Gmail users settings send as smime info operations · Get started

Operation google.gmail_users_settings_sendas_smimeinfo_get

Provider route: GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GoogleIntegration } from "@alter-ai/google";

async function execute(input: Parameters<GoogleIntegration["gmailUsersSettingsSendAsSmimeInfo"]["gmailUsersSettingsSendAsSmimeInfoGet"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.gmailUsersSettingsSendAsSmimeInfo.gmailUsersSettingsSendAsSmimeInfoGet(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_google import GoogleIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.gmail_users_settings_send_as_smime_info.gmail_users_settings_send_as_smime_info_get(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	The immutable ID for the SmimeInfo.
path.sendAsEmail	string	Required within parent	The email address that appears in the “From:” header for mail sent using this alias.
path.userId	string	Required within parent	The user’s email address. The special value `me` can be used to indicate the authenticated user. Default: me
query	object	Optional	Additional keys: not allowed
query.fields	string	Optional	Selector specifying which fields to include in a partial response.
query.prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
query.quotaUser	string	Optional	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Gets the specified S MIME config for the specified send-as alias For more information, see Manage S MIME certificates with the Gmail API (https: developers google com workspace gmail api guides smime certs) — response body

Referenced models: Gets the specified S MIME config for the specified send-as alias For more information, see Manage S MIME certificates with the Gmail API (https: developers google com workspace gmail api guides smime certs) — response body

Schemas

Gets the specified S MIME config for the specified send-as alias For more information, see Manage S MIME certificates with the Gmail API (https: developers google com workspace gmail api guides smime certs) — response body

Field	Type	Presence	Description and constraints
$	object	Root	An S/MIME email config.
encryptedKeyPassword	string	Optional	Encrypted key password, when key is encrypted.
expiration	string	Optional	When the certificate expires (in milliseconds since epoch). Format: int64
id	string	Optional	The immutable ID for the SmimeInfo.
isDefault	boolean	Optional	Whether this SmimeInfo is the default one for this user's send-as address.
issuerCn	string	Optional	The S/MIME certificate issuer's common name.
pem	string	Optional	PEM formatted X509 concatenated certificate string (standard base64 encoding). Format used for returning key, which includes public key as well as certificate chain (not private key).
pkcs12	string	Optional	PKCS#12 format containing a single private/public key pair and certificate chain. This format is only accepted from client for creating a new SmimeInfo and is never returned, because the private key is not intended to be exported. PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set appropriately. Format: byte

Policy, approvals and errors

SDK function policy ID: google.gmail_users_settings_sendas_smimeinfo_get. Catalog operation: gmail.users.settings.sendAs.smimeInfo.get. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["https://mail.google.com/", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly", "https://www.googleapis.com/auth/gmail.settings.basic", "https://www.googleapis.com/auth/gmail.settings.sharing"]

Official provider source