Skip to content

applicationCertificateAuthority.md

Latest commit

 

History

History
133 lines (94 loc) · 5.14 KB

applicationCertificateAuthority.md

File metadata and controls

133 lines (94 loc) · 5.14 KB

Application Certificate Authority Actions

Details on the various actions that can be performed on the Application Certificate Authority resource, including the expected parameters and the potential responses.

Contents

Delete

Deletes an application certificate authority

result = client.application_certificate_authority.delete(
    applicationId=my_application_id,
    applicationCertificateAuthorityId=my_application_certificate_authority_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, applicationCertificateAuthority.*, or applicationCertificateAuthority.delete.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
applicationCertificateAuthorityId string Y ID associated with the application certificate authority 575ec76c7ae143cd83dc4a96
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Success If application certificate authority was successfully deleted

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application certificate authority was not found

Get

Retrieves information on an application certificate authority

result = client.application_certificate_authority.get(
    applicationId=my_application_id,
    applicationCertificateAuthorityId=my_application_certificate_authority_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationCertificateAuthority.*, or applicationCertificateAuthority.get.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
applicationCertificateAuthorityId string Y ID associated with the application certificate authority 575ec76c7ae143cd83dc4a96
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Application Certificate Authority Application certificate authority information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application certificate authority was not found

Patch

Updates information about an application certificate authority

result = client.application_certificate_authority.patch(
    applicationId=my_application_id,
    applicationCertificateAuthorityId=my_application_certificate_authority_id,
    applicationCertificateAuthority=my_application_certificate_authority)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, applicationCertificateAuthority.*, or applicationCertificateAuthority.patch.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
applicationCertificateAuthorityId string Y ID associated with the application certificate authority 575ec76c7ae143cd83dc4a96
applicationCertificateAuthority Application Certificate Authority Patch Y Object containing new properties of the application certificate authority Application Certificate Authority Patch Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Application Certificate Authority Updated application certificate authority information

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application certificate authority was not found