PrivateCAConnectorforSCEP / Client / get_connector

get_connector

PrivateCAConnectorforSCEP.Client.get_connector(**kwargs)

Retrieves details about the specified Connector. Calling this action returns important details about the connector, such as the public SCEP URL where your clients can request certificates.

See also: AWS API Documentation

Request Syntax

response = client.get_connector(
    ConnectorArn='string'
)

Parameters:

ConnectorArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the connector.

Return type:

dict

Returns:

Response Syntax

{
    'Connector': {
        'Arn': 'string',
        'CertificateAuthorityArn': 'string',
        'Type': 'GENERAL_PURPOSE'|'INTUNE',
        'MobileDeviceManagement': {
            'Intune': {
                'AzureApplicationId': 'string',
                'Domain': 'string'
            }
        },
        'OpenIdConfiguration': {
            'Issuer': 'string',
            'Subject': 'string',
            'Audience': 'string'
        },
        'Status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
        'StatusReason': 'INTERNAL_FAILURE'|'PRIVATECA_ACCESS_DENIED'|'PRIVATECA_INVALID_STATE'|'PRIVATECA_RESOURCE_NOT_FOUND',
        'Endpoint': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  • Connector (dict) –

    The properties of the connector.

    • Arn (string) –

      The Amazon Resource Name (ARN) of the connector.

    • CertificateAuthorityArn (string) –

      The Amazon Resource Name (ARN) of the certificate authority associated with the connector.

    • Type (string) –

      The connector type.

    • MobileDeviceManagement (dict) –

      Contains settings relevant to the mobile device management system that you chose for the connector. If you didn’t configure MobileDeviceManagement, then the connector is for general-purpose use and this object is empty.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: Intune. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

      • Intune (dict) –

        Configuration settings for use with Microsoft Intune. For information about using Connector for SCEP for Microsoft Intune, see Using Connector for SCEP for Microsoft Intune.

        • AzureApplicationId (string) –

          The directory (tenant) ID from your Microsoft Entra ID app registration.

        • Domain (string) –

          The primary domain from your Microsoft Entra ID app registration.

    • OpenIdConfiguration (dict) –

      Contains OpenID Connect (OIDC) parameters for use with Connector for SCEP for Microsoft Intune. For more information about using Connector for SCEP for Microsoft Intune, see Using Connector for SCEP for Microsoft Intune.

      • Issuer (string) –

        The issuer value to copy into your Microsoft Entra app registration’s OIDC.

      • Subject (string) –

        The subject value to copy into your Microsoft Entra app registration’s OIDC.

      • Audience (string) –

        The audience value to copy into your Microsoft Entra app registration’s OIDC.

    • Status (string) –

      The connector’s status.

    • StatusReason (string) –

      Information about why connector creation failed, if status is FAILED.

    • Endpoint (string) –

      The connector’s HTTPS public SCEP URL.

    • CreatedAt (datetime) –

      The date and time that the connector was created.

    • UpdatedAt (datetime) –

      The date and time that the connector was updated.

Exceptions

• PrivateCAConnectorforSCEP.Client.exceptions.ResourceNotFoundException

• PrivateCAConnectorforSCEP.Client.exceptions.InternalServerException

• PrivateCAConnectorforSCEP.Client.exceptions.ValidationException

• PrivateCAConnectorforSCEP.Client.exceptions.ThrottlingException

• PrivateCAConnectorforSCEP.Client.exceptions.AccessDeniedException