---
title: MicrosoftGraphAPI
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-microsoftgraphapi
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-microsoftgraphapi.html
section_ids:
  sec-amster-entity-microsoftgraphapi-realm-ops: Realm Operations
  sec-amster-entity-microsoftgraphapi-realm-ops-create: create
  sec-amster-entity-microsoftgraphapi-realm-ops-delete: delete
  sec-amster-entity-microsoftgraphapi-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-microsoftgraphapi-realm-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-microsoftgraphapi-realm-ops-nextdescendents: nextdescendents
  sec-amster-entity-microsoftgraphapi-realm-ops-query: query
  sec-amster-entity-microsoftgraphapi-realm-ops-read: read
  sec-amster-entity-microsoftgraphapi-realm-ops-update: update
---

# MicrosoftGraphAPI

## Realm Operations

Resource path:

```
/realm-config/services/email/microsoftRestTransports
```

Resource version: `0.0`

### create

**Usage**

```
am> create MicrosoftGraphAPI --realm Realm --id id --body body
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "emailEndpoint" : {
        "title" : "Email Rest Endpoint URL",
        "description" : "Rest endpoint for sending emails",
        "propertyOrder" : 510,
        "required" : true,
        "type" : "string",
        "exampleValue" : "https://graph.microsoft.com/v1.0/users/<user_id>/sendMail"
      },
      "passwordPurpose" : {
        "title" : "Secret Label Identifier",
        "description" : "AM uses this identifier to create a specific secret label, using the template <code>am.services.mail.microsoftrest.%s.{{identifier}}.clientsecret</code> where {{identifier}} is the Secret Label Identifier. <br> The Secret Label identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}. <br> If this field is populated, this secret will take precedence over <code>am.services.email.microsoftrest.%s.clientsecret</code> where the identifier is the transport type name selected for the email service.",
        "propertyOrder" : 550,
        "required" : false,
        "type" : "string",
        "exampleValue" : ""
      },
      "tokenEndpoint" : {
        "title" : "OAuth2 Token Endpoint URL",
        "description" : "The endpoint for OAuth2 authentication",
        "propertyOrder" : 520,
        "required" : true,
        "type" : "string",
        "exampleValue" : "https://login.microsoftonline.com/<tennant_id>/oauth2/v2.0/token"
      },
      "scope" : {
        "title" : "OAuth2 Scopes",
        "description" : "The scopes to request as part of the OAuth2 authentication",
        "propertyOrder" : 540,
        "required" : true,
        "type" : "string",
        "exampleValue" : "https://graph.microsoft.com/.default"
      },
      "clientId" : {
        "title" : "OAuth2 Client Id",
        "description" : "The Client Id for use in OAuth2 authentication",
        "propertyOrder" : 530,
        "required" : true,
        "type" : "string",
        "exampleValue" : "clientId"
      },
      "emailImplClassName" : {
        "title" : "Email Message Implementation Class",
        "description" : "Specifies the class that sends email notifications, such as those sent for user registration and forgotten passwords.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      }
    }
  }
  ```

### delete

**Usage**

```
am> delete MicrosoftGraphAPI --realm Realm --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

**Usage**

```
am> action MicrosoftGraphAPI --realm Realm --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action MicrosoftGraphAPI --realm Realm --actionName getCreatableTypes
```

### nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

**Usage**

```
am> action MicrosoftGraphAPI --realm Realm --actionName nextdescendents
```

### query

Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.

**Usage**

```
am> query MicrosoftGraphAPI --realm Realm --filter filter
```

**Parameters**

* *\--filter*

  A CREST formatted query filter, where "true" will query all.

### read

**Usage**

```
am> read MicrosoftGraphAPI --realm Realm --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update MicrosoftGraphAPI --realm Realm --id id --body body
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "properties" : {
      "emailEndpoint" : {
        "title" : "Email Rest Endpoint URL",
        "description" : "Rest endpoint for sending emails",
        "propertyOrder" : 510,
        "required" : true,
        "type" : "string",
        "exampleValue" : "https://graph.microsoft.com/v1.0/users/<user_id>/sendMail"
      },
      "passwordPurpose" : {
        "title" : "Secret Label Identifier",
        "description" : "AM uses this identifier to create a specific secret label, using the template <code>am.services.mail.microsoftrest.%s.{{identifier}}.clientsecret</code> where {{identifier}} is the Secret Label Identifier. <br> The Secret Label identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}. <br> If this field is populated, this secret will take precedence over <code>am.services.email.microsoftrest.%s.clientsecret</code> where the identifier is the transport type name selected for the email service.",
        "propertyOrder" : 550,
        "required" : false,
        "type" : "string",
        "exampleValue" : ""
      },
      "tokenEndpoint" : {
        "title" : "OAuth2 Token Endpoint URL",
        "description" : "The endpoint for OAuth2 authentication",
        "propertyOrder" : 520,
        "required" : true,
        "type" : "string",
        "exampleValue" : "https://login.microsoftonline.com/<tennant_id>/oauth2/v2.0/token"
      },
      "scope" : {
        "title" : "OAuth2 Scopes",
        "description" : "The scopes to request as part of the OAuth2 authentication",
        "propertyOrder" : 540,
        "required" : true,
        "type" : "string",
        "exampleValue" : "https://graph.microsoft.com/.default"
      },
      "clientId" : {
        "title" : "OAuth2 Client Id",
        "description" : "The Client Id for use in OAuth2 authentication",
        "propertyOrder" : 530,
        "required" : true,
        "type" : "string",
        "exampleValue" : "clientId"
      },
      "emailImplClassName" : {
        "title" : "Email Message Implementation Class",
        "description" : "Specifies the class that sends email notifications, such as those sent for user registration and forgotten passwords.",
        "propertyOrder" : 100,
        "required" : true,
        "type" : "string",
        "exampleValue" : ""
      }
    }
  }
  ```