PATCH api/QMS/UserCertificates/Suspend   QMS   All Services

Suspends a QMS user certificate. If the associated certificate has its "expire on suspend" property set to true, then the user certificate will also be expired (i.e. its expiry date will be set to today's date). Returns 204 if successful. Returns an error code 4001 if the user certificate does not exist for the given parameters. Returns an error code 4003 if the associated certificate does not allow suspend, or if the user certificate is already suspended.

Request Information

Headers

Fields Type M/O/C Definition
AccountLoginName String(50) Mandatory Login name of an account used for logging into Galaxy application to perform the service call
AccountPassword String(50) Mandatory Password of an account used for logging into Galaxy application to perform the service call
SourceSystemID String(50) Mandatory Name or ID of application or system that initiated the call.
DomainID String(50) Mandatory Name or ID of the domain that the call is being made to. (Value will be 1, if the site only has one domain)
Accept String Optional Format in which client expects the response: [application/json] (default), [application/xml]
ContentType String Optional Format in which client is sending the request: [application/json] (default), [application/xml]

Parameters

NameDescriptionAdditional informationType
model 

                
                            
Define this parameter in the request body.

                		
                SuspendUserCertificateRequestModel
             
            

            

                
                
                    





    

    

        SuspendUserCertificateRequestModel:
        
          

            
             
PropertyNameTypeRequiredDescription

            
            
                    

                   
                        UserID
                        Int32
                        Mandatory
                        
                     

                    

                   
                        CertificateID
                        Int32
                        Mandatory
                        
                     


            

          

        		
    

    









                		
            

    



            
Request body formats




        
application/json, text/json

        

            Sample:

{
  "UserID": 1,
  "CertificateID": 2
}





        

        
application/xml, text/xml

        

            Sample:

<SuspendUserCertificateRequestModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <UserID>1</UserID>
  <CertificateID>2</CertificateID>
</SuspendUserCertificateRequestModel>





        



    
Return Type 

    

        
        
             
Return type null