Private CA Connector for SCEP

2024/06/11 - Private CA Connector for SCEP - 12 new api methods

Changes  Connector for SCEP allows you to use a managed, cloud CA to enroll mobile devices and networking gear. SCEP is a widely-adopted protocol used by mobile device management (MDM) solutions for enrolling mobile devices. With the connector, you can use AWS Private CA with popular MDM solutions.

ListConnectors (new) Link ¶

Lists the connectors belonging to your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.list_connectors(
    MaxResults=123,
    NextToken='string'
)
type MaxResults

integer

param MaxResults

The maximum number of objects that you want Connector for SCEP to return for this request. If more objects are available, in the response, Connector for SCEP provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

type NextToken

string

param NextToken

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

rtype

dict

returns

Response Syntax

{
    'Connectors': [
        {
            '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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Connectors (list) --

      The connectors belonging to your Amazon Web Services account.

      • (dict) --

        Lists the Amazon Web Services Private CA SCEP connectors belonging to your Amazon Web Services account.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the connector.

        • CertificateAuthorityArn (string) --

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

        • 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 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. Status can be creating, active, deleting, or failed.

        • 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 challenge was created.

        • UpdatedAt (datetime) --

          The date and time that the challenge was updated.

    • NextToken (string) --

      When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

GetConnector (new) Link ¶

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

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

string

param ConnectorArn

[REQUIRED]

The Amazon Resource Name (ARN) of the connector.

rtype

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.

TagResource (new) Link ¶

Adds one or more tags to your resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
type ResourceArn

string

param ResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type Tags

dict

param Tags

[REQUIRED]

The key-value pairs to associate with the resource.

  • (string) --

    • (string) --

returns

None

ListTagsForResource (new) Link ¶

Retrieves the tags associated with the specified resource. Tags are key-value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceArn='string'
)
type ResourceArn

string

param ResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

rtype

dict

returns

Response Syntax

{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • Tags (dict) --

      The key-value pairs to associate with the resource.

      • (string) --

        • (string) --

CreateChallenge (new) Link ¶

For general-purpose connectors. Creates a challenge password for the specified connector. The SCEP protocol uses a challenge password to authenticate a request before issuing a certificate from a certificate authority (CA). Your SCEP clients include the challenge password as part of their certificate request to Connector for SCEP. To retrieve the connector Amazon Resource Names (ARNs) for the connectors in your account, call ListConnectors.

To create additional challenge passwords for the connector, call CreateChallenge again. We recommend frequently rotating your challenge passwords.

See also: AWS API Documentation

Request Syntax

client.create_challenge(
    ConnectorArn='string',
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)
type ConnectorArn

string

param ConnectorArn

[REQUIRED]

The Amazon Resource Name (ARN) of the connector that you want to create a challenge for.

type ClientToken

string

param ClientToken

Custom string that can be used to distinguish between calls to the CreateChallenge action. Client tokens for CreateChallenge time out after five minutes. Therefore, if you call CreateChallenge multiple times with the same client token within five minutes, Connector for SCEP recognizes that you are requesting only one challenge and will only respond with one. If you change the client token for each call, Connector for SCEP recognizes that you are requesting multiple challenge passwords.

This field is autopopulated if not provided.

type Tags

dict

param Tags

The key-value pairs to associate with the resource.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'Challenge': {
        'Arn': 'string',
        'ConnectorArn': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1),
        'Password': 'string'
    }
}

Response Structure

  • (dict) --

    • Challenge (dict) --

      Returns the challenge details for the specified connector.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the challenge.

      • ConnectorArn (string) --

        The Amazon Resource Name (ARN) of the connector.

      • CreatedAt (datetime) --

        The date and time that the challenge was created.

      • UpdatedAt (datetime) --

        The date and time that the challenge was updated.

      • Password (string) --

        The SCEP challenge password, in UUID format.

GetChallengeMetadata (new) Link ¶

Retrieves the metadata for the specified Challenge.

See also: AWS API Documentation

Request Syntax

client.get_challenge_metadata(
    ChallengeArn='string'
)
type ChallengeArn

string

param ChallengeArn

[REQUIRED]

The Amazon Resource Name (ARN) of the challenge.

rtype

dict

returns

Response Syntax

{
    'ChallengeMetadata': {
        'Arn': 'string',
        'ConnectorArn': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • ChallengeMetadata (dict) --

      The metadata for the challenge.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the challenge.

      • ConnectorArn (string) --

        The Amazon Resource Name (ARN) of the connector.

      • CreatedAt (datetime) --

        The date and time that the connector was created.

      • UpdatedAt (datetime) --

        The date and time that the connector was updated.

UntagResource (new) Link ¶

Removes one or more tags from your resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
type ResourceArn

string

param ResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) of the resource.

type TagKeys

list

param TagKeys

[REQUIRED]

Specifies a list of tag keys that you want to remove from the specified resources.

  • (string) --

returns

None

ListChallengeMetadata (new) Link ¶

Retrieves the challenge metadata for the specified ARN.

See also: AWS API Documentation

Request Syntax

client.list_challenge_metadata(
    MaxResults=123,
    NextToken='string',
    ConnectorArn='string'
)
type MaxResults

integer

param MaxResults

The maximum number of objects that you want Connector for SCEP to return for this request. If more objects are available, in the response, Connector for SCEP provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

type NextToken

string

param NextToken

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

type ConnectorArn

string

param ConnectorArn

[REQUIRED]

The Amazon Resource Name (ARN) of the connector.

rtype

dict

returns

Response Syntax

{
    'Challenges': [
        {
            'Arn': 'string',
            'ConnectorArn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Challenges (list) --

      The challenge metadata for the challenges belonging to your Amazon Web Services account.

      • (dict) --

        Details about the specified challenge, returned by the GetChallengeMetadata action.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the challenge.

        • ConnectorArn (string) --

          The Amazon Resource Name (ARN) of the connector.

        • CreatedAt (datetime) --

          The date and time that the challenge was created.

        • UpdatedAt (datetime) --

          The date and time that the challenge was updated.

    • NextToken (string) --

      When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

GetChallengePassword (new) Link ¶

Retrieves the challenge password for the specified Challenge.

See also: AWS API Documentation

Request Syntax

client.get_challenge_password(
    ChallengeArn='string'
)
type ChallengeArn

string

param ChallengeArn

[REQUIRED]

The Amazon Resource Name (ARN) of the challenge.

rtype

dict

returns

Response Syntax

{
    'Password': 'string'
}

Response Structure

  • (dict) --

    • Password (string) --

      The SCEP challenge password.

CreateConnector (new) Link ¶

Creates a SCEP connector. A SCEP connector links Amazon Web Services Private Certificate Authority to your SCEP-compatible devices and mobile device management (MDM) systems. Before you create a connector, you must complete a set of prerequisites, including creation of a private certificate authority (CA) to use with this connector. For more information, see Connector for SCEP prerequisites.

See also: AWS API Documentation

Request Syntax

client.create_connector(
    CertificateAuthorityArn='string',
    MobileDeviceManagement={
        'Intune': {
            'AzureApplicationId': 'string',
            'Domain': 'string'
        }
    },
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)
type CertificateAuthorityArn

string

param CertificateAuthorityArn

[REQUIRED]

The Amazon Resource Name (ARN) of the Amazon Web Services Private Certificate Authority certificate authority to use with this connector. Due to security vulnerabilities present in the SCEP protocol, we recommend using a private CA that's dedicated for use with the connector.

To retrieve the private CAs associated with your account, you can call ListCertificateAuthorities using the Amazon Web Services Private CA API.

type MobileDeviceManagement

dict

param MobileDeviceManagement

If you don't supply a value, by default Connector for SCEP creates a connector for general-purpose use. A general-purpose connector is designed to work with clients or endpoints that support the SCEP protocol, except Connector for SCEP for Microsoft Intune. With connectors for general-purpose use, you manage SCEP challenge passwords using Connector for SCEP. For information about considerations and limitations with using Connector for SCEP, see Considerations and Limitations.

If you provide an IntuneConfiguration , Connector for SCEP creates a connector for use with Microsoft Intune, and you manage the challenge passwords using Microsoft Intune. For more information, see Using Connector for SCEP for Microsoft Intune.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Intune.

  • 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) -- [REQUIRED]

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

    • Domain (string) -- [REQUIRED]

      The primary domain from your Microsoft Entra ID app registration.

type ClientToken

string

param ClientToken

Custom string that can be used to distinguish between calls to the CreateChallenge action. Client tokens for CreateChallenge time out after five minutes. Therefore, if you call CreateChallenge multiple times with the same client token within five minutes, Connector for SCEP recognizes that you are requesting only one challenge and will only respond with one. If you change the client token for each call, Connector for SCEP recognizes that you are requesting multiple challenge passwords.

This field is autopopulated if not provided.

type Tags

dict

param Tags

The key-value pairs to associate with the resource.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'ConnectorArn': 'string'
}

Response Structure

  • (dict) --

    • ConnectorArn (string) --

      Returns the Amazon Resource Name (ARN) of the connector.

DeleteConnector (new) Link ¶

Deletes the specified Connector. This operation also deletes any challenges associated with the connector.

See also: AWS API Documentation

Request Syntax

client.delete_connector(
    ConnectorArn='string'
)
type ConnectorArn

string

param ConnectorArn

[REQUIRED]

The Amazon Resource Name (ARN) of the connector to delete.

returns

None

DeleteChallenge (new) Link ¶

Deletes the specified Challenge.

See also: AWS API Documentation

Request Syntax

client.delete_challenge(
    ChallengeArn='string'
)
type ChallengeArn

string

param ChallengeArn

[REQUIRED]

The Amazon Resource Name (ARN) of the challenge password to delete.

returns

None