PcaConnectorAd

import { PcaConnectorAd } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/pcaconnectorad.ts?docs=full";

class PcaConnectorAd {

constructor(apiFactory: client.ApiFactory);

async createConnector(params: CreateConnectorRequest, opts?: client.RequestOptions): Promise<CreateConnectorResponse>;

async createDirectoryRegistration(params: CreateDirectoryRegistrationRequest, opts?: client.RequestOptions): Promise<CreateDirectoryRegistrationResponse>;

async createServicePrincipalName(params: CreateServicePrincipalNameRequest, opts?: client.RequestOptions): Promise<void>;

async createTemplate(params: CreateTemplateRequest, opts?: client.RequestOptions): Promise<CreateTemplateResponse>;

async createTemplateGroupAccessControlEntry(params: CreateTemplateGroupAccessControlEntryRequest, opts?: client.RequestOptions): Promise<void>;

async deleteConnector(params: DeleteConnectorRequest, opts?: client.RequestOptions): Promise<void>;

async deleteDirectoryRegistration(params: DeleteDirectoryRegistrationRequest, opts?: client.RequestOptions): Promise<void>;

async deleteServicePrincipalName(params: DeleteServicePrincipalNameRequest, opts?: client.RequestOptions): Promise<void>;

async deleteTemplate(params: DeleteTemplateRequest, opts?: client.RequestOptions): Promise<void>;

async deleteTemplateGroupAccessControlEntry(params: DeleteTemplateGroupAccessControlEntryRequest, opts?: client.RequestOptions): Promise<void>;

async getConnector(params: GetConnectorRequest, opts?: client.RequestOptions): Promise<GetConnectorResponse>;

async getDirectoryRegistration(params: GetDirectoryRegistrationRequest, opts?: client.RequestOptions): Promise<GetDirectoryRegistrationResponse>;

async getServicePrincipalName(params: GetServicePrincipalNameRequest, opts?: client.RequestOptions): Promise<GetServicePrincipalNameResponse>;

async getTemplate(params: GetTemplateRequest, opts?: client.RequestOptions): Promise<GetTemplateResponse>;

async getTemplateGroupAccessControlEntry(params: GetTemplateGroupAccessControlEntryRequest, opts?: client.RequestOptions): Promise<GetTemplateGroupAccessControlEntryResponse>;

async listConnectors(params?: ListConnectorsRequest, opts?: client.RequestOptions): Promise<ListConnectorsResponse>;

async listDirectoryRegistrations(params?: ListDirectoryRegistrationsRequest, opts?: client.RequestOptions): Promise<ListDirectoryRegistrationsResponse>;

async listServicePrincipalNames(params: ListServicePrincipalNamesRequest, opts?: client.RequestOptions): Promise<ListServicePrincipalNamesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listTemplateGroupAccessControlEntries(params: ListTemplateGroupAccessControlEntriesRequest, opts?: client.RequestOptions): Promise<ListTemplateGroupAccessControlEntriesResponse>;

async listTemplates(params: ListTemplatesRequest, opts?: client.RequestOptions): Promise<ListTemplatesResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateTemplate(params: UpdateTemplateRequest, opts?: client.RequestOptions): Promise<void>;

async updateTemplateGroupAccessControlEntry(params: UpdateTemplateGroupAccessControlEntryRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new PcaConnectorAd(apiFactory: client.ApiFactory)

[src]

§Methods

createConnector(params: CreateConnectorRequest, opts?: client.RequestOptions): Promise<CreateConnectorResponse>

[src]

Creates a connector between Amazon Web Services Private CA and an Active Directory. You must specify the private CA, directory ID, and security groups.

createDirectoryRegistration(params: CreateDirectoryRegistrationRequest, opts?: client.RequestOptions): Promise<CreateDirectoryRegistrationResponse>

[src]

Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory

createServicePrincipalName(params: CreateServicePrincipalNameRequest, opts?: client.RequestOptions): Promise<void>

[src]

Creates a service principal name (SPN) for the service account in Active Directory. Kerberos authentication uses SPNs to associate a service instance with a service sign-in account.

createTemplate(params: CreateTemplateRequest, opts?: client.RequestOptions): Promise<CreateTemplateResponse>

[src]

Creates an Active Directory compatible certificate template. The connectors issues certificates using these templates based on the requester’s Active Directory group membership.

createTemplateGroupAccessControlEntry(params: CreateTemplateGroupAccessControlEntryRequest, opts?: client.RequestOptions): Promise<void>

[src]

Create a group access control entry. Allow or deny Active Directory groups from enrolling and/or autoenrolling with the template based on the group security identifiers (SIDs).

deleteConnector(params: DeleteConnectorRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the connector that you want to delete. You can find the ARN by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can deregister your directory by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration action.

deleteDirectoryRegistration(params: DeleteDirectoryRegistrationRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a directory registration. Deleting a directory registration deauthorizes Amazon Web Services Private CA with the directory.

deleteServicePrincipalName(params: DeleteServicePrincipalNameRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.

deleteTemplate(params: DeleteTemplateRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a template. Certificates issued using the template are still valid until they are revoked or expired.

deleteTemplateGroupAccessControlEntry(params: DeleteTemplateGroupAccessControlEntryRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a group access control entry.

getConnector(params: GetConnectorRequest, opts?: client.RequestOptions): Promise<GetConnectorResponse>

[src]

Lists information about your connector. You specify the connector on input by its ARN (Amazon Resource Name).

getDirectoryRegistration(params: GetDirectoryRegistrationRequest, opts?: client.RequestOptions): Promise<GetDirectoryRegistrationResponse>

[src]

A structure that contains information about your directory registration.

getServicePrincipalName(params: GetServicePrincipalNameRequest, opts?: client.RequestOptions): Promise<GetServicePrincipalNameResponse>

[src]

Lists the service principal name that the connector uses to authenticate with Active Directory.

getTemplate(params: GetTemplateRequest, opts?: client.RequestOptions): Promise<GetTemplateResponse>

[src]

Retrieves a certificate template that the connector uses to issue certificates from a private CA.

getTemplateGroupAccessControlEntry(params: GetTemplateGroupAccessControlEntryRequest, opts?: client.RequestOptions): Promise<GetTemplateGroupAccessControlEntryResponse>

[src]

Retrieves the group access control entries for a template.

listConnectors(params?: ListConnectorsRequest, opts?: client.RequestOptions): Promise<ListConnectorsResponse>

[src]

Lists the connectors that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.

listDirectoryRegistrations(params?: ListDirectoryRegistrationsRequest, opts?: client.RequestOptions): Promise<ListDirectoryRegistrationsResponse>

[src]

Lists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration action.

listServicePrincipalNames(params: ListServicePrincipalNamesRequest, opts?: client.RequestOptions): Promise<ListServicePrincipalNamesResponse>

[src]

Lists the service principal names that the connector uses to authenticate with Active Directory.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Lists the tags, if any, that are associated with your resource.

listTemplateGroupAccessControlEntries(params: ListTemplateGroupAccessControlEntriesRequest, opts?: client.RequestOptions): Promise<ListTemplateGroupAccessControlEntriesResponse>

[src]

Lists group access control entries you created.

listTemplates(params: ListTemplatesRequest, opts?: client.RequestOptions): Promise<ListTemplatesResponse>

[src]

Lists the templates, if any, that are associated with a connector.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds one or more tags to your resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes one or more tags from your resource.

updateTemplate(params: UpdateTemplateRequest, opts?: client.RequestOptions): Promise<void>

[src]

Update template configuration to define the information included in certificates.

updateTemplateGroupAccessControlEntry(params: UpdateTemplateGroupAccessControlEntryRequest, opts?: client.RequestOptions): Promise<void>

[src]

Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]