Class DomainCertAuthorityService

Hierarchy

  • DomainCertAuthorityService

Constructors

constructor

Methods

createDomainCertAuthority deleteDomainCertAuthority getDomainCertAuthorities getDomainCertAuthority replaceDomainCertAuthority updateDomainCertAuthority

Constructors

constructor

Methods

Static createDomainCertAuthority

  • Create a Domain Certificate Authority object. Create a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value. The creation of instances of this object are synchronized to HA mates via config-sync.

    Certificate Authorities trusted for domain verification.

    Attribute Identifying Required Read-Only Write-Only Deprecated Opaque
    certAuthorityName x x

    A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation.

    This has been available since 2.19.

    Returns

    DomainCertAuthorityResponse The Domain Certificate Authority object's attributes after being created, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: DomainCertAuthority;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: DomainCertAuthority

        The Domain Certificate Authority object's attributes. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<DomainCertAuthorityResponse | SempMetaOnlyResponse>

Static deleteDomainCertAuthority

  • Delete a Domain Certificate Authority object. Delete a Domain Certificate Authority object. The deletion of instances of this object are synchronized to HA mates via config-sync.

    Certificate Authorities trusted for domain verification.

    A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation.

    This has been available since 2.19.

    Returns

    SempMetaOnlyResponse The request metadata.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          certAuthorityName: string;
          xContextId?: string;
      }
      • certAuthorityName: string

        The name of the Certificate Authority. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<SempMetaOnlyResponse>

Static getDomainCertAuthorities

  • Get a list of Domain Certificate Authority objects. Get a list of Domain Certificate Authority objects.

    Certificate Authorities trusted for domain verification.

    Attribute Identifying Write-Only Deprecated Opaque
    certAuthorityName x

    A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.

    This has been available since 2.19.

    Returns

    DomainCertAuthoritiesResponse The list of Domain Certificate Authority objects' attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          count?: number;
          cursor?: string;
          opaquePassword?: string;
          select?: string[];
          where?: string[];
          xContextId?: string;
      }
      • Optional count?: number

        Limit the count of objects in the response. See the documentation for the count parameter. *

      • Optional cursor?: string

        The cursor, or position, for the next page of objects. See the documentation for the cursor parameter. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional where?: string[]

        Include in the response only objects where certain conditions are true. See the the documentation for the where parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<DomainCertAuthoritiesResponse | SempMetaOnlyResponse>

Static getDomainCertAuthority

  • Get a Domain Certificate Authority object. Get a Domain Certificate Authority object.

    Certificate Authorities trusted for domain verification.

    Attribute Identifying Write-Only Deprecated Opaque
    certAuthorityName x

    A SEMP client authorized with a minimum access scope/level of "global/read-only" is required to perform this operation.

    This has been available since 2.19.

    Returns

    DomainCertAuthorityResponse The Domain Certificate Authority object's attributes, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          certAuthorityName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • certAuthorityName: string

        The name of the Certificate Authority. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<DomainCertAuthorityResponse | SempMetaOnlyResponse>

Static replaceDomainCertAuthority

  • Replace a Domain Certificate Authority object. Replace a Domain Certificate Authority object. Any attribute missing from the request will be set to its default value, subject to the exceptions in note 4.

    Certificate Authorities trusted for domain verification.

    Attribute Identifying Const Read-Only Write-Only Requires-Disable Deprecated Opaque
    certAuthorityName x x

    A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation.

    This has been available since 2.19.

    Returns

    DomainCertAuthorityResponse The Domain Certificate Authority object's attributes after being replaced, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: DomainCertAuthority;
          certAuthorityName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: DomainCertAuthority

        The Domain Certificate Authority object's attributes. *

      • certAuthorityName: string

        The name of the Certificate Authority. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<DomainCertAuthorityResponse | SempMetaOnlyResponse>

Static updateDomainCertAuthority

  • Update a Domain Certificate Authority object. Update a Domain Certificate Authority object. Any attribute missing from the request will be left unchanged.

    Certificate Authorities trusted for domain verification.

    Attribute Identifying Read-Only Write-Only Requires-Disable Deprecated Opaque
    certAuthorityName x x

    A SEMP client authorized with a minimum access scope/level of "global/admin" is required to perform this operation.

    This has been available since 2.19.

    Returns

    DomainCertAuthorityResponse The Domain Certificate Authority object's attributes after being updated, and the request metadata.

    Returns

    SempMetaOnlyResponse The error response.

    Throws

    ApiError

    Parameters

    • __namedParameters: {
          body: DomainCertAuthority;
          certAuthorityName: string;
          opaquePassword?: string;
          select?: string[];
          xContextId?: string;
      }
      • body: DomainCertAuthority

        The Domain Certificate Authority object's attributes. *

      • certAuthorityName: string

        The name of the Certificate Authority. *

      • Optional opaquePassword?: string

        Accept opaque attributes in the request or return opaque attributes in the response, encrypted with the specified password. See the documentation for the opaquePassword parameter. *

      • Optional select?: string[]

        Include in the response only selected attributes of the object, or exclude from the response selected attributes of the object. See the documentation for the select parameter. *

      • Optional xContextId?: string

        Optional context id the request is running. *

    Returns CancelablePromise<DomainCertAuthorityResponse | SempMetaOnlyResponse>

Settings

Member Visibility

Theme