Skip to main content
API Explorer|API Explorer
System Management/User Configuration
POSTUser ConfigurationSince 4.10.0SynchronousAuth Required

Attach CCS Certificate to Account

Attach CCS Certificate to Account

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • accountUuidStringRequired

    Account UUID

Body Fields

  • certificateUuidString

    UUID of the CCS certificate

  • stateString

    Enable or disable. Specifies whether to enable UKey authentication for login when attaching the CCS certificate to the user. If set to enable, the user must pass UKey authentication for subsequent logins. If set to disable, UKey authentication is not enabled temporarily, but can be enabled later through UpdateCCSCertificateUserState.

  • system TagsList

    System tags

  • userTagsList

    User tags

Responses

200 OK

On success, this API returns the following response structure.

  • successbooleanRequired

    Whether the attach operation is successful

  • inventoryCCSCertificateInventoryRequired

    For details, see inventory

    • uuidStringRequired

      Resource UUID. Uniquely identifies the resource.

    • algorithmStringRequired

      Certificate type

    • formatStringRequired

      Certificate format. CER for Chinese national cryptographic standards. Other formats include CRT, DER, JKS, etc.

    • issuerDNStringRequired

      Issuer DN (issuer-DN-distinguished name), for example, CN=sm2,O=test,C=cn

    • subjectDNStringRequired

      Subject DN

    • serNumberLongRequired

      Certificate serial number. Combined with subjectDN as a composite key, it is globally unique.

    • effectiveTimeTimestampRequired

      Effective date

    • expirationTimeTimestampRequired

      Expiration date

    • createDateTimestampRequired

      Creation time

    • lastOpDateTimestampRequired

      Last modification time

    • userCertificateRefsListRequired

      For details, see userCertificateRefs

      • userUuidStringRequired

        User UUID

      • certificateUuidStringRequired

        CCS certificate UUID

      • createDateTimestampRequired

        Creation time

      • lastOpDateTimestampRequired

        Last modification time

      • stateCCSCertificateUserStateRequired

        For details, see state

        • EnabledCCSCertificateUserStateRequired

          Verification required

        • DisabledCCSCertificateUserStateRequired

          Verification not required

  • errorErrorCodeRequired

    Error code. If not null, the operation has failed. This field is null when the operation succeeds. For details, see error

    • codeStringRequired

      Error code number. The globally unique identifier of the error, for example, SYS.1000 or HOST.1001.

    • descriptionStringRequired

      Brief description of the error

    • detailsStringRequired

      Detailed information about the error

    • elaborationStringRequired

      Reserved field. Default is null.

    • opaqueLinkedHashMapRequired

      Reserved field. Default is null.

    • causeErrorCodeRequired

      Root error. The source error that caused the current error. This field is null if no root error exists.

Endpoint

POST/zstack/v1/crypto/ccs-certificate/attach-account/{accountUuid}

/zstack/v1/crypto/ccs-certificate/attach-account/{accountUuid}

Operation ID

AttachCCSCertificateToUser

Permalink

Request Example

curl -X POST 'http://{host}/zstack/v1/crypto/ccs-certificate/attach-account/{accountUuid}' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"certificateUuid":"<certificateUuid>","state":"<state>","system Tags":["<system Tags>"],"userTags":["<userTags>"]}'

Response Example

200
{ "inventory": { "uuid": "271c21f7ef8c4385b09846341cc9deac", "algorithm": "SM2", "format": "CER", "issuerDN": "C\u003dcn,O\u003dinfosec,OU\u003dsystem,CN\u003dca62_sm2", "subjectDN": "C\u003dCN,O\u003dZStack,OU\u003dZStack,CN\u003dZStackTest2", "serNumber": "13055887750776402041", "effectiveTime": "Oct 15, 2021 10:50:09 AM", "expirationTime": "Oct 15, 2024 10:50:09 AM" } }

Change History

This API has no change history records yet.

View all change history