Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph
Important
APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
Represents a collection of public key infrastructure (PKI) instances for the certificate-based authentication method. You must enable the certificate-based authentication method in the tenant to manage these PKI instances.
Inherits from directoryObject.
For more information, see Set up Microsoft Entra certificate-based authentication.
Methods
| Method | Return type | Description |
|---|---|---|
| List | certificateBasedAuthPki collection | Get a list of the certificateBasedAuthPki objects and their properties. |
| Create | certificateBasedAuthPki | Create a new certificateBasedAuthPki object. |
| Get | certificateBasedAuthPki | Read the properties and relationships of a certificateBasedAuthPki object. |
| Update | certificateBasedAuthPki | Update the properties of a certificateBasedAuthPki object. |
| Delete | None | Delete a certificateBasedAuthPki object. |
| Upload | None | Download the PKI file and populate the certificateAuthorities. |
| List deleted items | directoryObject collection | Retrieve the certificateBasedAuthPki objects deleted in the tenant in the last 30 days. |
| Get deleted item | directoryObject collection | Retrieve a deleted certificateBasedAuthPki object by ID. |
| Restore deleted item | directoryObject collection | Restore a certificateBasedAuthPki object deleted in the tenant in the last 30 days. |
| Permanently delete item | directoryObject collection | Permanently delete a deleted certificateBasedAuthPki object from the tenant. |
Properties
| Property | Type | Description |
|---|---|---|
| deletedDateTime | DateTimeOffset | The date and time when the object was soft deleted. Inherited from base class and null for objects that are not deleted. Inherited from directoryObject. |
| displayName | String | The name of the object. Maximum length is 256 characters. |
| id | String | The ID of the object. Inherited from entity. |
| lastModifiedDateTime | DateTimeOffset | The date and time when the object was created or last modified. |
| status | String | The status of any asynchronous jobs runs on the object which can be upload or delete. |
| statusDetails | String | The status details of the upload/deleted operation of PKI (Public Key Infrastructure). |
Relationships
| Relationship | Type | Description |
|---|---|---|
| certificateAuthorities | certificateAuthorityDetail collection | The collection of certificate authorities contained in this public key infrastructure resource. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.certificateBasedAuthPki",
"id": "String (identifier)",
"deletedDateTime": "String (timestamp)",
"displayName": "String",
"status": "String",
"statusDetails": "String",
"lastModifiedDateTime": "String (timestamp)"
}