MicrosoftGraphAPI
Realm Operations
Resource path:
/realm-config/services/email/microsoftRestTransports
Resource version: 1.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:
{ "type" : "object", "properties" : { "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" : "" }, "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" }, "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" }, "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" }, "clientId" : { "title" : "OAuth2 Client Id", "description" : "The Client Id for use in OAuth2 authentication", "propertyOrder" : 530, "required" : true, "type" : "string", "exampleValue" : "clientId" } } }
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:
{ "type" : "object", "properties" : { "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" : "" }, "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" }, "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" }, "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" }, "clientId" : { "title" : "OAuth2 Client Id", "description" : "The Client Id for use in OAuth2 authentication", "propertyOrder" : 530, "required" : true, "type" : "string", "exampleValue" : "clientId" } } }