.png){kind=logo}
Certificate
- 14 Oct 2024
- 2 Minutes to read
- Print
- DarkLight
- PDF
Certificate
- Updated on 14 Oct 2024
- 2 Minutes to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get-LiquitCertificate
Synopsis
This command displays a list of all certificates available within the Liquit Workspace. Alternatively, you can select a specific certificate.
Syntax
Get-LiquitCertificate
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitCertificate
[-ID] <guid[]>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitCertificate
[-EntityRef] <EntityRef[]>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitCertificate
[-Search] <string>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Get-LiquitCertificate
[-Name] <string>
[-LiquitContext <LiquitContext>]
[<CommonParameters>]
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Search | <string> | This parameter serves a similar purpose to the search box found in the access policies table from the Liquit Workspace UI. It enables users to search multiple columns within the table, such as Subject and Issuer. When a search term is provided, the parameter filters records by matching values in these indexed columns. However, it's important to note that not all columns in the table are indexed, meaning that searches for values in these non-indexed columns will not return results. Non-indexed columns include for example the ID and columns containing checkboxes. | ||
| Name | <string> | Searches on the certificate name itself. | ||
| LiquitContext | <LiquitContext> | Determines the selected zone. | No | Default |
Examples
Example 1: Get-LiquitCertificate
Get-LiquitCertificate
This command displays all certificates defined within the Liquit Workspace.
Example 2: Get-LiquitCertificate
Get-LiquitCertificate -id 00000000-0000-0000-0000-000000000000
This command displays the specified certificate.
New-LiquitCertificate
Synopsis
This command creates a new certificate.
Syntax
New-LiquitCertificate
[-CommonName] <string>
[-Description] <string>]
[-DaysValid] <uint32>]
[-KeySize] {512 | 1024 | 2048 | 4096 | 8192 }]
[-LiquitContext <LiquitContext>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Example
New-LiquitCertificate -CommonName "PowerShell Certificate"
This command creates a new certificate named “PowerShell Certificate”.
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| CommonName | <string> | The name of the certificate to be created. | Yes | |
| Description | <string> | The description of the certificate. | No | |
| DaysValid | <uint32> | The number of days the certificate is valid. | No | |
| KeySize | {512 | 1024 | 2048 | 4096 | 8192} | The key size of the certificate. | No | |
| LiquitContext | <LiquitContext> | Determines the selected zone. | No | Default |
Set-LiquitCertificate
Synopsis
This command edits the properties of a certificate.
Syntax
Set-LiquitCertificate
[-Certificate] <Certificate[]>
[-Description <string>]
[-LiquitContext <LiquitContext>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Example
$certificate = Get-LiquitCertificate -id 00000000-0000-0000-0000-000000000000
Set-LiquitCertificate -Description "SetDescription" -certificate $certificate
This command updates the certificate.
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Certificate | <Certificate[]> | The certificate to be updated. | Yes | |
| Description | <string> | The description of the certificate. | No | |
| LiquitContext | <LiquitContext> | Determines the selected zone. | No | Default |
Remove-LiquitCertificate
Synopsis
This command removes a certificate.
Syntax
Remove-LiquitCertificate
[-Certificate] <Certificate[]>
[-LiquitContext <LiquitContext>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Example
$certificate = Get-LiquitCertificate -ID 00000000-0000-0000-0000-000000000000
Remove-LiquitCertificate -certificate $certificate
This command removes the selected certificate.
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Certificate | <Certificate[]> | The certificate you want to remove. | Yes | |
| LiquitContext | <LiquitContext> | Determines the selected zone. | No | Default |
Export-LiquitCertificate
Synopsis
This command exports a certificate.
Syntax
Export-LiquitCertificate
[-Certificate] <Certificate[]>
[-Path] <string>
[-Type] {pfx | pem | key | der}
[-Password] <string>
[-IncludeChain] <bool>
[-LiquitContext <LiquitContext>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Example
$certificate = Get-LiquitCertificate -ID 00000000-0000-0000-0000-000000000000
Export-LiquitCertificate -certificate $certificate -path C:\temp\ExportCertificate.pxf
This command exports the selected certificate.
Parameters
| Name | Value | Description | Required | Default value |
|---|---|---|---|---|
| Certificate | <Certificate[]> | Determines the certificate. | Yes | |
| Path | <string> | Determines the path. | Yes | |
| Type | {pfx | pem | key | der} | Determines the type. | No | |
| Password | <string> | The password of the certificate. | No | |
| IncludeChain | <bool> | Include the certificate chain if present. | No | |
| LiquitContext | <LiquitContext> | Determines the selected zone. | No | Default |
For more details, see Certificates.
Was this article helpful?