@datafire/windows_graphrbac
v5.0.0
Published
DataFire integration for GraphRbacManagementClient
Downloads
29
Readme
@datafire/windows_graphrbac
Client library for GraphRbacManagementClient
Installation and Usage
npm install --save @datafire/windows_graphrbac
let windows_graphrbac = require('@datafire/windows_graphrbac').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
The Graph RBAC Management Client
Actions
Applications_List
Lists applications by filter parameters.
windows_graphrbac.Applications_List({
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- $filter
string
: The filters to apply to the operation. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- $filter
Output
- output ApplicationListResult
Applications_Create
Create a new application.
windows_graphrbac.Applications_Create({
"parameters": {
"displayName": ""
},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- parameters required ApplicationCreateParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
Output
- output Application
Applications_Delete
Delete an application.
windows_graphrbac.Applications_Delete({
"applicationObjectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- applicationObjectId required
string
: Application object ID. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- applicationObjectId required
Output
Output schema unknown
Applications_Get
Get an application by object ID.
windows_graphrbac.Applications_Get({
"applicationObjectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- applicationObjectId required
string
: Application object ID. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- applicationObjectId required
Output
- output Application
Applications_Patch
Update an existing application.
windows_graphrbac.Applications_Patch({
"applicationObjectId": "",
"parameters": {},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- applicationObjectId required
string
: Application object ID. - parameters required ApplicationUpdateParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- applicationObjectId required
Output
Output schema unknown
Applications_AddOwner
Add an owner to an application.
windows_graphrbac.Applications_AddOwner({
"applicationObjectId": "",
"parameters": {
"url": ""
},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- applicationObjectId required
string
: The object ID of the application to which to add the owner. - parameters required AddOwnerParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- applicationObjectId required
Output
Output schema unknown
Applications_RemoveOwner
Remove a member from owners.
windows_graphrbac.Applications_RemoveOwner({
"applicationObjectId": "",
"ownerObjectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- applicationObjectId required
string
: The object ID of the application from which to remove the owner. - ownerObjectId required
string
: Owner object id - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- applicationObjectId required
Output
Output schema unknown
Applications_ListKeyCredentials
Get the keyCredentials associated with an application.
windows_graphrbac.Applications_ListKeyCredentials({
"applicationObjectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- applicationObjectId required
string
: Application object ID. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- applicationObjectId required
Output
- output KeyCredentialListResult
Applications_UpdateKeyCredentials
Update the keyCredentials associated with an application.
windows_graphrbac.Applications_UpdateKeyCredentials({
"applicationObjectId": "",
"parameters": {
"value": []
},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- applicationObjectId required
string
: Application object ID. - parameters required KeyCredentialsUpdateParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- applicationObjectId required
Output
Output schema unknown
Applications_ListOwners
The owners are a set of non-admin users who are allowed to modify this object.
windows_graphrbac.Applications_ListOwners({
"applicationObjectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- applicationObjectId required
string
: The object ID of the application for which to get owners. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- applicationObjectId required
Output
- output DirectoryObjectListResult
Applications_ListPasswordCredentials
Get the passwordCredentials associated with an application.
windows_graphrbac.Applications_ListPasswordCredentials({
"applicationObjectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- applicationObjectId required
string
: Application object ID. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- applicationObjectId required
Output
- output PasswordCredentialListResult
Applications_UpdatePasswordCredentials
Update passwordCredentials associated with an application.
windows_graphrbac.Applications_UpdatePasswordCredentials({
"applicationObjectId": "",
"parameters": {
"value": []
},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- applicationObjectId required
string
: Application object ID. - parameters required PasswordCredentialsUpdateParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- applicationObjectId required
Output
Output schema unknown
DeletedApplications_List
Gets a list of deleted applications in the directory.
windows_graphrbac.DeletedApplications_List({
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- $filter
string
: The filter to apply to the operation. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- $filter
Output
- output ApplicationListResult
DeletedApplications_HardDelete
Hard-delete an application.
windows_graphrbac.DeletedApplications_HardDelete({
"applicationObjectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- applicationObjectId required
string
: Application object ID. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- applicationObjectId required
Output
Output schema unknown
DeletedApplications_Restore
Restores the deleted application in the directory.
windows_graphrbac.DeletedApplications_Restore({
"objectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: Application object ID. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
- output Application
Domains_List
Gets a list of domains for the current tenant.
windows_graphrbac.Domains_List({
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- $filter
string
: The filter to apply to the operation. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- $filter
Output
- output DomainListResult
Domains_Get
Gets a specific domain in the current tenant.
windows_graphrbac.Domains_Get({
"domainName": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- domainName required
string
: name of the domain. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- domainName required
Output
- output Domain
Objects_GetObjectsByObjectIds
Gets the directory objects specified in a list of object IDs. You can also specify which resource collections (users, groups, etc.) should be searched by specifying the optional types parameter.
windows_graphrbac.Objects_GetObjectsByObjectIds({
"parameters": {},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- parameters required GetObjectsParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
Output
- output DirectoryObjectListResult
Groups_List
Gets list of groups for the current tenant.
windows_graphrbac.Groups_List({
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- $filter
string
: The filter to apply to the operation. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- $filter
Output
- output GroupListResult
Groups_Create
Create a group in the directory.
windows_graphrbac.Groups_Create({
"parameters": {
"displayName": "",
"mailEnabled": true,
"mailNickname": "",
"securityEnabled": true
},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- parameters required GroupCreateParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
Output
- output ADGroup
Groups_AddMember
Add a member to a group.
windows_graphrbac.Groups_AddMember({
"groupObjectId": "",
"parameters": {
"url": ""
},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- groupObjectId required
string
: The object ID of the group to which to add the member. - parameters required GroupAddMemberParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- groupObjectId required
Output
Output schema unknown
Groups_RemoveMember
Remove a member from a group.
windows_graphrbac.Groups_RemoveMember({
"groupObjectId": "",
"memberObjectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- groupObjectId required
string
: The object ID of the group from which to remove the member. - memberObjectId required
string
: Member object id - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- groupObjectId required
Output
Output schema unknown
Groups_Delete
Delete a group from the directory.
windows_graphrbac.Groups_Delete({
"objectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the group to delete. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
Output schema unknown
Groups_Get
Gets group information from the directory.
windows_graphrbac.Groups_Get({
"objectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the user for which to get group information. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
- output ADGroup
Groups_AddOwner
Add an owner to a group.
windows_graphrbac.Groups_AddOwner({
"objectId": "",
"parameters": {
"url": ""
},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the application to which to add the owner. - parameters required AddOwnerParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
Output schema unknown
Groups_RemoveOwner
Remove a member from owners.
windows_graphrbac.Groups_RemoveOwner({
"objectId": "",
"ownerObjectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the group from which to remove the owner. - ownerObjectId required
string
: Owner object id - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
Output schema unknown
Groups_GetMemberGroups
Gets a collection of object IDs of groups of which the specified group is a member.
windows_graphrbac.Groups_GetMemberGroups({
"objectId": "",
"parameters": {
"securityEnabledOnly": true
},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the group for which to get group membership. - parameters required GroupGetMemberGroupsParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
- output GroupGetMemberGroupsResult
Groups_GetGroupMembers
Gets the members of a group.
windows_graphrbac.Groups_GetGroupMembers({
"objectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the group whose members should be retrieved. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
- output DirectoryObjectListResult
Groups_ListOwners
The owners are a set of non-admin users who are allowed to modify this object.
windows_graphrbac.Groups_ListOwners({
"objectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the group for which to get owners. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
- output DirectoryObjectListResult
Groups_IsMemberOf
Checks whether the specified user, group, contact, or service principal is a direct or transitive member of the specified group.
windows_graphrbac.Groups_IsMemberOf({
"parameters": {
"groupId": "",
"memberId": ""
},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- parameters required CheckGroupMembershipParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
Output
- output CheckGroupMembershipResult
SignedInUser_Get
Gets the details for the currently logged-in user.
windows_graphrbac.SignedInUser_Get({
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- api-version required
Output
- output User
SignedInUser_ListOwnedObjects
Get the list of directory objects that are owned by the user.
windows_graphrbac.SignedInUser_ListOwnedObjects({
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- api-version required
Output
- output DirectoryObjectListResult
OAuth2PermissionGrant_List
Queries OAuth2 permissions grants for the relevant SP ObjectId of an app.
windows_graphrbac.OAuth2PermissionGrant_List({
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- $filter
string
: This is the Service Principal ObjectId associated with the app - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- $filter
Output
OAuth2PermissionGrant_Create
Grants OAuth2 permissions for the relevant resource Ids of an app.
windows_graphrbac.OAuth2PermissionGrant_Create({
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- body OAuth2PermissionGrant
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
Output
- output OAuth2PermissionGrant
OAuth2PermissionGrant_Delete
Delete a OAuth2 permission grant for the relevant resource Ids of an app.
windows_graphrbac.OAuth2PermissionGrant_Delete({
"objectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of a permission grant. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
Output schema unknown
ServicePrincipals_List
Gets a list of service principals from the current tenant.
windows_graphrbac.ServicePrincipals_List({
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- $filter
string
: The filter to apply to the operation. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- $filter
Output
- output ServicePrincipalListResult
ServicePrincipals_Create
Creates a service principal in the directory.
windows_graphrbac.ServicePrincipals_Create({
"parameters": {
"appId": ""
},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- parameters required ServicePrincipalCreateParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
Output
- output ServicePrincipal
ServicePrincipals_Delete
Deletes a service principal from the directory.
windows_graphrbac.ServicePrincipals_Delete({
"objectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the service principal to delete. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
Output schema unknown
ServicePrincipals_Get
Gets service principal information from the directory. Query by objectId or pass a filter to query by appId
windows_graphrbac.ServicePrincipals_Get({
"objectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the service principal to get. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
- output ServicePrincipal
ServicePrincipals_Update
Updates a service principal in the directory.
windows_graphrbac.ServicePrincipals_Update({
"objectId": "",
"parameters": {},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the service principal to delete. - parameters required ServicePrincipalUpdateParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
Output schema unknown
ServicePrincipals_ListKeyCredentials
Get the keyCredentials associated with the specified service principal.
windows_graphrbac.ServicePrincipals_ListKeyCredentials({
"objectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the service principal for which to get keyCredentials. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
- output KeyCredentialListResult
ServicePrincipals_UpdateKeyCredentials
Update the keyCredentials associated with a service principal.
windows_graphrbac.ServicePrincipals_UpdateKeyCredentials({
"objectId": "",
"parameters": {
"value": []
},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID for which to get service principal information. - parameters required KeyCredentialsUpdateParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
Output schema unknown
ServicePrincipals_ListOwners
The owners are a set of non-admin users who are allowed to modify this object.
windows_graphrbac.ServicePrincipals_ListOwners({
"objectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the service principal for which to get owners. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
- output DirectoryObjectListResult
ServicePrincipals_ListPasswordCredentials
Gets the passwordCredentials associated with a service principal.
windows_graphrbac.ServicePrincipals_ListPasswordCredentials({
"objectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the service principal. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
- output PasswordCredentialListResult
ServicePrincipals_UpdatePasswordCredentials
Updates the passwordCredentials associated with a service principal.
windows_graphrbac.ServicePrincipals_UpdatePasswordCredentials({
"objectId": "",
"parameters": {
"value": []
},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the service principal. - parameters required PasswordCredentialsUpdateParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
Output schema unknown
Applications_GetServicePrincipalsIdByAppId
Gets an object id for a given application id from the current tenant.
windows_graphrbac.Applications_GetServicePrincipalsIdByAppId({
"api-version": "",
"tenantID": "",
"applicationID": ""
}, context)
Input
- input
object
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID. - applicationID required
string
: The application ID.
- api-version required
Output
- output ServicePrincipalObjectResult
Users_List
Gets list of users for the current tenant.
windows_graphrbac.Users_List({
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- $filter
string
: The filter to apply to the operation. - $expand
string
: The expand value for the operation result. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- $filter
Output
- output UserListResult
Users_Create
Create a new user.
windows_graphrbac.Users_Create({
"parameters": {
"accountEnabled": true,
"displayName": "",
"passwordProfile": {
"password": ""
},
"userPrincipalName": "",
"mailNickname": ""
},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- parameters required UserCreateParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
Output
- output User
Users_GetMemberGroups
Gets a collection that contains the object IDs of the groups of which the user is a member.
windows_graphrbac.Users_GetMemberGroups({
"objectId": "",
"parameters": {
"securityEnabledOnly": true
},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- objectId required
string
: The object ID of the user for which to get group membership. - parameters required UserGetMemberGroupsParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- objectId required
Output
- output UserGetMemberGroupsResult
Users_Delete
Delete a user.
windows_graphrbac.Users_Delete({
"upnOrObjectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- upnOrObjectId required
string
: The object ID or principal name of the user to delete. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- upnOrObjectId required
Output
Output schema unknown
Users_Get
Gets user information from the directory.
windows_graphrbac.Users_Get({
"upnOrObjectId": "",
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- upnOrObjectId required
string
: The object ID or principal name of the user for which to get information. - api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- upnOrObjectId required
Output
- output User
Users_Update
Updates a user.
windows_graphrbac.Users_Update({
"upnOrObjectId": "",
"parameters": {},
"api-version": "",
"tenantID": ""
}, context)
Input
- input
object
- upnOrObjectId required
string
: The object ID or principal name of the user to update. - parameters required UserUpdateParameters
- api-version required
string
: Client API version. - tenantID required
string
: The tenant ID.
- upnOrObjectId required
Output
Output schema unknown
Definitions
ADGroup
- ADGroup
object
: Active Directory group information.- displayName
string
: The display name of the group. - mail
string
: The primary email address of the group. - mailEnabled
boolean
: Whether the group is mail-enabled. Must be false. This is because only pure security groups can be created using the Graph API. - mailNickname
string
: The mail alias for the group. - securityEnabled
boolean
: Whether the group is security-enable. - deletionTimestamp
string
: The time at which the directory object was deleted. - objectId
string
: The object ID. - objectType required
string
: The object type.
- displayName
AddOwnerParameters
- AddOwnerParameters
object
: Request parameters for adding a owner to an application.- url required
string
: A owner object URL, such as "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd", where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner (user, application, servicePrincipal, group) to be added.
- url required
AppRole
- AppRole
object
- allowedMemberTypes
array
: Specifies whether this app role definition can be assigned to users and groups by setting to 'User', or to other applications (that are accessing this application in daemon service scenarios) by setting to 'Application', or to both.- items
string
- items
- description
string
: Permission help text that appears in the admin app assignment and consent experiences. - displayName
string
: Display name for the permission that appears in the admin consent and app assignment experiences. - id
string
: Unique role identifier inside the appRoles collection. - isEnabled
boolean
: When creating or updating a role definition, this must be set to true (which is the default). To delete a role, this must first be set to false. At that point, in a subsequent call, this role may be removed. - value
string
: Specifies the value of the roles claim that the application should expect in the authentication and access tokens.
- allowedMemberTypes
Application
- Application
object
: Active Directory application information.- allowGuestsSignIn
boolean
: A property on the application to indicate if the application accepts other IDPs or not or partially accepts. - allowPassthroughUsers
boolean
: Indicates that the application supports pass through users who have no presence in the resource tenant. - appId
string
: The application ID. - appLogoUrl
string
: The url for the application logo image stored in a CDN. - appPermissions
array
: The application permissions.- items
string
- items
- appRoles
array
: The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.- items AppRole
- availableToOtherTenants
boolean
: Whether the application is available to other tenants. - displayName
string
: The display name of the application. - errorUrl
string
: A URL provided by the author of the application to report errors when using the application. - groupMembershipClaims GroupMembershipClaims
- homepage
string
: The home page of the application. - identifierUris
array
: A collection of URIs for the application.- items
string
- items
- informationalUrls InformationalUrl
- isDeviceOnlyAuthSupported
boolean
: Specifies whether this application supports device authentication without a user. The default is false. - keyCredentials
array
: A collection of KeyCredential objects.- items KeyCredential
- knownClientApplications
array
: Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).- items
string
- items
- logoutUrl
string
: the url of the logout page - oauth2AllowImplicitFlow
boolean
: Whether to allow implicit grant flow for OAuth2 - oauth2AllowUrlPathMatching
boolean
: Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false. - oauth2Permissions
array
: The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.- items OAuth2Permission
- oauth2RequirePostResponse
boolean
: Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed. - optionalClaims OptionalClaims
- orgRestrictions
array
: A list of tenants allowed to access application.- items
string
- items
- passwordCredentials
array
: A collection of PasswordCredential objects- items PasswordCredential
- preAuthorizedApplications
array
: list of pre-authorized applications.- items PreAuthorizedApplication
- publicClient
boolean
: Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false. - publisherDomain
string
: Reliable domain which can be used to identify an application. - replyUrls
array
: A collection of reply URLs for the application.- items
string
- items
- requiredResourceAccess
array
: Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.- items RequiredResourceAccess
- samlMetadataUrl
string
: The URL to the SAML metadata for the application. - signInAudience
string
: Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts). - wwwHomepage
string
: The primary Web page. - deletionTimestamp
string
: The time at which the directory object was deleted. - objectId
string
: The object ID. - objectType required
string
: The object type.
- allowGuestsSignIn
ApplicationBase
- ApplicationBase
object
: Active Directive Application common properties shared among GET, POST and PATCH- allowGuestsSignIn
boolean
: A property on the application to indicate if the application accepts other IDPs or not or partially accepts. - allowPassthroughUsers
boolean
: Indicates that the application supports pass through users who have no presence in the resource tenant. - appLogoUrl
string
: The url for the application logo image stored in a CDN. - appPermissions
array
: The application permissions.- items
string
- items
- appRoles
array
: The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.- items AppRole
- availableToOtherTenants
boolean
: Whether the application is available to other tenants. - errorUrl
string
: A URL provided by the author of the application to report errors when using the application. - groupMembershipClaims GroupMembershipClaims
- homepage
string
: The home page of the application. - informationalUrls InformationalUrl
- isDeviceOnlyAuthSupported
boolean
: Specifies whether this application supports device authentication without a user. The default is false. - keyCredentials
array
: A collection of KeyCredential objects.- items KeyCredential
- knownClientApplications
array
: Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).- items
string
- items
- logoutUrl
string
: the url of the logout page - oauth2AllowImplicitFlow
boolean
: Whether to allow implicit grant flow for OAuth2 - oauth2AllowUrlPathMatching
boolean
: Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false. - oauth2Permissions
array
: The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.- items OAuth2Permission
- oauth2RequirePostResponse
boolean
: Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed. - optionalClaims OptionalClaims
- orgRestrictions
array
: A list of tenants allowed to access application.- items
string
- items
- passwordCredentials
array
: A collection of PasswordCredential objects- items PasswordCredential
- preAuthorizedApplications
array
: list of pre-authorized applications.- items PreAuthorizedApplication
- publicClient
boolean
: Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false. - publisherDomain
string
: Reliable domain which can be used to identify an application. - replyUrls
array
: A collection of reply URLs for the application.- items
string
- items
- requiredResourceAccess
array
: Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.- items RequiredResourceAccess
- samlMetadataUrl
string
: The URL to the SAML metadata for the application. - signInAudience
string
: Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts). - wwwHomepage
string
: The primary Web page.
- allowGuestsSignIn
ApplicationCreateParameters
- ApplicationCreateParameters
object
: Request parameters for creating a new application.- displayName required
string
: The display name of the application. - identifierUris
array
: A collection of URIs for the application.- items
string
- items
- allowGuestsSignIn
boolean
: A property on the application to indicate if the application accepts other IDPs or not or partially accepts. - allowPassthroughUsers
boolean
: Indicates that the application supports pass through users who have no presence in the resource tenant. - appLogoUrl
string
: The url for the application logo image stored in a CDN. - appPermissions
array
: The application permissions.- items
string
- items
- appRoles
array
: The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.- items AppRole
- availableToOtherTenants
boolean
: Whether the application is available to other tenants. - errorUrl
string
: A URL provided by the author of the application to report errors when using the application. - groupMembershipClaims GroupMembershipClaims
- homepage
string
: The home page of the application. - informationalUrls InformationalUrl
- isDeviceOnlyAuthSupported
boolean
: Specifies whether this application supports device authentication without a user. The default is false. - keyCredentials
array
: A collection of KeyCredential objects.- items KeyCredential
- knownClientApplications
array
: Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).- items
string
- items
- logoutUrl
string
: the url of the logout page - oauth2AllowImplicitFlow
boolean
: Whether to allow implicit grant flow for OAuth2 - oauth2AllowUrlPathMatching
boolean
: Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false. - oauth2Permissions
array
: The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.- items OAuth2Permission
- oauth2RequirePostResponse
boolean
: Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed. - optionalClaims OptionalClaims
- orgRestrictions
array
: A list of tenants allowed to access application.- items
string
- items
- passwordCredentials
array
: A collection of PasswordCredential objects- items PasswordCredential
- preAuthorizedApplications
array
: list of pre-authorized applications.- items PreAuthorizedApplication
- publicClient
boolean
: Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false. - publisherDomain
string
: Reliable domain which can be used to identify an application. - replyUrls
array
: A collection of reply URLs for the application.- items
string
- items
- requiredResourceAccess
array
: Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.- items RequiredResourceAccess
- samlMetadataUrl
string
: The URL to the SAML metadata for the application. - signInAudience
string
: Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts). - wwwHomepage
string
: The primary Web page.
- displayName required
ApplicationListResult
- ApplicationListResult
object
: Application list operation result.- odata.nextLink
string
: The URL to get the next set of results. - value
array
: A collection of applications.- items Application
- odata.nextLink
ApplicationUpdateParameters
- ApplicationUpdateParameters
object
: Request parameters for updating a new application.- displayName
string
: The display name of the application. - identifierUris
array
: A collection of URIs for the application.- items
string
- items
- allowGuestsSignIn
boolean
: A property on the application to indicate if the application accepts other IDPs or not or partially accepts. - allowPassthroughUsers
boolean
: Indicates that the application supports pass through users who have no presence in the resource tenant. - appLogoUrl
string
: The url for the application logo image stored in a CDN. - appPermissions
array
: The application permissions.- items
string
- items
- appRoles
array
: The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.- items AppRole
- availableToOtherTenants
boolean
: Whether the application is available to other tenants. - errorUrl
string
: A URL provided by the author of the application to report errors when using the application. - groupMembershipClaims GroupMembershipClaims
- homepage
string
: The home page of the application. - informationalUrls InformationalUrl
- isDeviceOnlyAuthSupported
boolean
: Specifies whether this application supports device authentication without a user. The default is false. - keyCredentials
array
: A collection of KeyCredential objects.- items KeyCredential
- knownClientApplications
array
: Client applications that are tied to this resource application. Consent to any of the known client applications will result in implicit consent to the resource application through a combined consent dialog (showing the OAuth permission scopes required by the client and the resource).- items
string
- items
- logoutUrl
string
: the url of the logout page - oauth2AllowImplicitFlow
boolean
: Whether to allow implicit grant flow for OAuth2 - oauth2AllowUrlPathMatching
boolean
: Specifies whether during a token Request Azure AD will allow path matching of the redirect URI against the applications collection of replyURLs. The default is false. - oauth2Permissions
array
: The collection of OAuth 2.0 permission scopes that the web API (resource) application exposes to client applications. These permission scopes may be granted to client applications during consent.- items OAuth2Permission
- oauth2RequirePostResponse
boolean
: Specifies whether, as part of OAuth 2.0 token requests, Azure AD will allow POST requests, as opposed to GET requests. The default is false, which specifies that only GET requests will be allowed. - optionalClaims OptionalClaims
- orgRestrictions
array
: A list of tenants allowed to access application.- items
string
- items
- passwordCredentials
array
: A collection of PasswordCredential objects- items PasswordCredential
- preAuthorizedApplications
array
: list of pre-authorized applications.- items PreAuthorizedApplication
- publicClient
boolean
: Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false. - publisherDomain
string
: Reliable domain which can be used to identify an application. - replyUrls
array
: A collection of reply URLs for the application.- items
string
- items
- requiredResourceAccess
array
: Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience.- items RequiredResourceAccess
- samlMetadataUrl
string
: The URL to the SAML metadata for the application. - signInAudience
string
: Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts). - wwwHomepage
string
: The primary Web page.
- displayName
CheckGroupMembershipParameters
- CheckGroupMembershipParameters
object
: Request parameters for IsMemberOf API call.- groupId required
string
: The object ID of the group to check. - memberId required
string
: The object ID of the contact, group, user, or service principal to check for membership in the specified group.
- groupId required
CheckGroupMembershipResult
- CheckGroupMembershipResult
object
: Server response for IsMemberOf API call- value
boolean
: True if the specified user, group, contact, or service principal has either direct or transitive membership in the specified group; otherwise, false.
- value
DirectoryObject
- DirectoryObject
object
: Represents an Azure Active Directory object.- deletionTimestamp
string
: The time at which the directory object was deleted. - objectId
string
: The object ID. - objectType required
string
: The object type.
- deletionTimestamp
DirectoryObjectListResult
- DirectoryObjectListResult
object
: DirectoryObject list operation result.- odata.nextLink
string
: The URL to get the next set of results. - value
array
: A collection of DirectoryObject.- items DirectoryObject
- odata.nextLink
Domain
- Domain
object
: Active Directory Domain information.- authenticationType
string
: the type of the authentication into the domain. - isDefault
boolean
: if this is the default domain in the tenant. - isVerified
boolean
: if this domain's ownership is verified. - name required
string
: the domain name.
- authenticationType
DomainListResult
- DomainListResult
object
: Server response for Get tenant domains API call.- value
array
: the list of domains.- items Domain
- value
ErrorMessage
- ErrorMessage
object
: Active Directory error message.- value
string
: Error message value.
- value
GetObjectsParameters
- GetObjectsParameters
object
: Request parameters for the GetObjectsByObjectIds API.- includeDirectoryObjectReferences
boolean
: If true, also searches for object IDs in the partner tenant. - objectIds
array
: The requested object IDs.- items
string
- items
- types
array
: The requested object types.- items
string
- items
- includeDirectoryObjectReferences
GraphError
- GraphError
object
: Active Directory error information.- odata.error OdataError
GroupAddMemberParameters
- GroupAddMemberParameters
object
: Request parameters for adding a member to a group.- url required
string
: A member object URL, such as "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd", where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the member (user, application, servicePrincipal, group) to be added.
- url required
GroupCreateParameters
- GroupCreateParameters
object
: Request parameters for creating a new group.- displayName required
string
: Group display name - mailEnabled required
boolean
(values: false): Whether the group is mail-enabled. Must be false. This is because only pure security groups can be created using the Graph API. - mailNickname required
string
: Mail nickname - securityEnabled required
boolean
(values: true): Whether the group is a security group. Must be true. This is because only pure security groups can be created using the Graph API.
- displayName required
GroupGetMemberGroupsParameters
- GroupGetMemberGroupsParameters
object
: Request parameters for GetMemberGroups API call.- securityEnabledOnly required
boolean
: If true, only membership in security-enabled groups should be checked. Otherwise, membership in all groups should be checked.
- securityEnabledOnly required
GroupGetMemberGroupsResult
- GroupGetMemberGroupsResult
object
: Server response for GetMemberGroups API call.- value
array
: A collection of group IDs of which the group is a member.- items
string
- items
- value
GroupListResult
- GroupListResult
object
: Server response for Get tenant groups API call- odata.nextLink
string
: The URL to get the next set of results. - value
array
: A collection of Active Directory groups.- items ADGroup
- odata.nextLink
GroupMembershipClaims
- GroupMembershipClaims
string
(values: None, SecurityGroup, All): Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects.
InformationalUrl
- InformationalUrl
object
: Represents a group of URIs that provide terms of service, marketing, support and privacy policy information about an application. The default value for each string is null.- marketing
string
: The marketing URI - privacy
string
: The privacy policy URI - support
string
: The support URI - termsOfService
string
: The terms of service URI
- marketing
KeyCredential
- KeyCredential
object
: Active Directory Key Credential information.- customKeyIdentifier
string
: Custom Key Identifier - endDate
string
: End date. - keyId
string
: Key ID. - startDate
string
: Start date. - type
string
: Type. Acceptable values are 'AsymmetricX509Cert' and 'Symmetric'. - usage
string
: Usage. Acceptable values are 'Verify' and 'Sign'. - value
string
: Key value.
- customKeyIdentifier
KeyCredentialListResult
- KeyCredentialListResult
object
: KeyCredential list operation result.- value
array
: A collection of KeyCredentials.- items KeyCredential
- value
KeyCredentialsUpdateParameters
- KeyCredentialsUpdateParameters
object
: Request parameters for a KeyCredentials update operation- value required
array
: A collection of KeyCredentials.- items KeyCredential
- value required
OAuth2Permission
- OAuth2Permission
object
: Represents an OAuth 2.0 delegated permission scope. The specified OAuth 2.0 delegated permission scopes may be requested by client applications (through the requiredResourceAccess collection on the Application object) when calling a resource application. The oauth2Permissions property of the ServicePrincipal entity and of the Application entity is a collection of OAuth2Permission.- adminConsentDescription
string
: Permission help text that appears in the admin consent and app assignment experiences. - adminConsentDisplayName
string
: Display name for the permission that appears in the admin consent and app assignment experiences. - id
string
: Unique scope permission identifier inside the oauth2Permissions collection. - isEnabled
boolean
: When creating or updating a permission, this property must be set to true (which is the default). To delete a permission, this property must first be set to false. At that point, in a subsequent call, the permission may be removed. - type
string
: Specifies whether this scope permission can be consented to by an end user, or whether it is a tenant-wide permission that must be consented to by a Company Administrator. Possible values are "User" or "Admin". - userConsentDescription
string
: Permission help text that appears in the end user consent experience. - userConsentDisplayName
string
: Display name for the permission that appears in the end user consent experience. - value
string
: The value of the scope claim that the resource application should expect in the OAuth 2.0 access token.
- adminConsentDescription
OAuth2PermissionGrant
- OAuth2PermissionGrant
object
- clientId
string
: The id of the resource's service principal granted consent to impersonate the user when accessing the resource (represented by the resourceId property). - consentType
string
(values: AllPrincipals, Principal): Indicates if consent was provided by the administrator (on behalf of the organization) or by an individual. - expiryTime
string
: Expiry time for TTL - objectId
string
: The id of the permission grant - odata.type
string
: Microsoft.DirectoryServices.OAuth2PermissionGrant - principalId
string
: When consent type is Principal, this property specifies the id of the user that granted consent and applies only for that user. - resourceId
string
: Object Id of the resource you want to grant - scope
string
: Specifies the value of the scope claim that the resource application should expect in the OAuth 2.0 access token. For example, User.Read - startTime
string
: Start time for TTL
- clientId
OAuth2PermissionGrantListResult
- OAuth2PermissionGrantListResult
object
: Server response for get oauth2 permissions grants- odata.nextLink
string
: the URL to get the next set of results. - value
array
: the list of oauth2 permissions grants- items OAuth2PermissionGrant
- odata.nextLink
OdataError
- OdataError
object
: Active Directory OData error information.- code
string
: Error code. - message ErrorMessage
- code
OptionalClaim
- OptionalClaim
object
: Specifying the claims to be included in a token.- additionalProperties
object
- essential
boolean
: Is this a required claim. - name
string
: Claim name. - source
string
: Claim source.
- additionalProperties
OptionalClaims
- OptionalClaims
object
: Specifying the claims to be included in the token.- accessToken
array
: Optional claims requested to be included in the access token.- items OptionalClaim
- idToken
array
: Optional claims requested to be included in the id token.- items OptionalClaim
- samlToken
array
: Optional claims requested to be included in the saml token.- items OptionalClaim
- accessToken
PasswordCredential
- PasswordCredential
object
: Active Directory Password Credential information.- customKeyIdentifier
string
: Custom Key Identifier - endDate
string
: End date. - keyId
string
: Key ID. - startDate
string
: Start date. - value
string
: Key value.
- customKeyIdentifier
PasswordCredentialListResult
- PasswordCredentialListResult
object
: PasswordCredential list operation result.- value
array
: A collection of PasswordCredentials.- items PasswordCredential
- value
PasswordCredentialsUpdateParameters
- PasswordCredentialsUpdateParameters
object
: Request parameters for a PasswordCredentials update operation.- value required
array
: A collection of PasswordCredentials.- items PasswordCredential
- value required
PasswordProfile
- PasswordProfile
object
: The password profile associated with a user.- forceChangePasswordNextLogin
boolean
: Whether to force a password change on next login. - password required
string
: Password
- forceChangePasswordNextLogin
PreAuthorizedApplication
- PreAuthorizedApplication
object
: Contains information about pre authorized client application.- appId
string
: Represents the application id. - extensions
array
: Collection of extensions from the resource application. - permissions
array
: Collection of required app permissions/entitlements from the resource application.
- appId
PreAuthorizedApplicationExtension
- PreAuthorizedApplicationExtension
object
: Representation of an app PreAuthorizedApplicationExtension required by a pre authorized client app.- conditions
array
: The extension's conditions.- items
string
- items
- conditions
PreAuthorizedApplicationPermission
- PreAuthorizedApplicationPermission
object
: Contains information about the pre-authorized permissions.- accessGrants
array
: The list of permissions.- items
string
- items
- directAccessGrant
boolean
: Indicates whether the permission set is DirectAccess or impersonation.
- accessGrants
RequiredResourceAccess
- RequiredResourceAccess
object
: Specifies the set of OAuth 2.0 permission scopes and app roles under the specified resource that an application requires access to. The specified OAuth 2.0 permission scopes may be requested by client applications (through the requiredResourceAccess collection) when calling a resource application. The requiredResourceAccess property of the Application entity is a collection of RequiredResourceAccess.- resourceAccess required
array
: The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource.- items ResourceAccess
- resourceAppId
string
: The unique identifier for the resource that the application requires access to. This should be equal to the appId declared on the target resource application.
- resourceAccess required
ResourceAccess
- ResourceAccess
object
: Specifies an OAuth 2.0 permission scope or an app role that an application requires. The resourceAccess property of the RequiredResourceAccess type is a collection of ResourceAccess.- id required
string
: The unique identifier for one of the OAuth2Permission or AppRole instances that the resource application exposes. - type
string
: Specifies whether the id property references an OAuth2Permission or an AppRole. Possible values are "scope" or "role".
- id required
ServicePrincipal
- ServicePrincipal
object
: Active Directory service principal information.- accountEnabled
boolean
: whether or not the service principal account is enabled - alternativeNames
array
: alternative names- items
string
- items
- appDisplayName
string
: The display name exposed by the associated application. - appId
string
: The application ID. - appOwnerTenantId
string
- appRoleAssignmentRequired
boolean
: Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application. - appRoles
array
: The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.- items AppRole
- displayName
string
: The display name of the service principal. - errorUrl
string
: A URL provided by the author of the associated application to report errors when using the application. - homepage
string
: The URL to the homepage of the associated application. - keyCredentials
array
: The collection of key credentials associated with the service principal.- items KeyCredential
- logoutUrl
string
: A URL provided by the author of the associated application to logout - oauth2Permissions
array
: The OAuth 2.0 permissions exposed by the associated application.- items OAuth2Permission
- passwordCredentials
array
: The collection of password credentials associated with the service principal.- items PasswordCredential
- preferredTokenSigningKeyThumbprint
string
: The thumbprint of preferred certificate to sign the token - publisherName
string
: The publisher's name of the associated application - replyUrls
array
: The URLs that user tokens are sent to for sign in with the associated application. The redirect URIs that the oAuth 2.0 authorization code and access tokens are sent to for the associated application.- items
string
- items
- samlMetadataUrl
string
: The URL to the SAML metadata of the associated application - servicePrincipalNames
array
: A collection of service principal names.- items
string
- items
- servicePrincipalType
string
: the type of the service principal - tags
array
: Optional list of tags that you can apply to your service principals. Not nullable.- items
string
- items
- deletionTimestamp
string
: The time at which the directory object was deleted. - objectId
string
: The object ID. - objectType required
string
: The object type.
- accountEnabled
ServicePrincipalBase
- ServicePrincipalBase
object
: Active Directory service principal common properties shared among GET, POST and PATCH- accountEnabled
boolean
: whether or not the service principal account is enabled - appRoleAssignmentRequired
boolean
: Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application. - keyCredentials
array
: The collection of key credentials associated with the service principal.- items KeyCredential
- passwordCredentials
array
: The collection of password credentials associated with the service principal.- items PasswordCredential
- servicePrincipalType
string
: the type of the service principal - tags
array
: Optional list of tags that you can apply to your service principals. Not nullable.- items
string
- items
- accountEnabled
ServicePrincipalCreateParameters
- ServicePrincipalCreateParameters
object
: Request parameters for creating a new service principal.- appId required
string
: The application ID. - accountEnabled
boolean
: whether or not the service principal account is enabled - appRoleAssignmentRequired
boolean
: Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application. - keyCredentials
array
: The collection of key credentials associated with the service principal.- items KeyCredential
- passwordCredentials
array
: The collection of password credentials associated with the service principal.- items PasswordCredential
- servicePrincipalType
string
: the type of the service principal - tags
array
: Optional list of tags that you can apply to your service principals. Not nullable.- items
string
- items
- appId required
ServicePrincipalListResult
- ServicePrincipalListResult
object
: Server response for get tenant service principals API call.- odata.nextLink
string
: the URL to get the next set of results. - value
array
: the list of service principals.- items ServicePrincipal
- odata.nextLink
ServicePrincipalObjectResult
- ServicePrincipalObjectResult
object
: Service Principal Object Result.- odata.metadata
string
: The URL representing edm equivalent. - value
string
: The Object ID of the service principal with the specified application ID.
- odata.metadata
ServicePrincipalUpdateParameters
- ServicePrincipalUpdateParameters
object
: Request parameters for update an existing service principal.- accountEnabled
boolean
: whether or not the service principal account is enabled - appRoleAssignmentRequired
boolean
: Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application. - keyCredentials
array
: The collection of key credentials associated with the service principal.- items KeyCredential
- passwordCredentials
array
: The collection of password credentials associated with the service principal.- items PasswordCredential
- servicePrincipalType
string
: the type of the service principal - tags
array
: Optional list of tags that you can apply to your service principals. Not nullable.- items
string
- items
- accountEnabled
SignInName
- SignInName
object
: Contains information ab