< Back
New-AADIntGuestInvitation
Post
NAME New-AADIntGuestInvitation
SYNOPSIS
Invites an user to AAD
SYNTAX
New-AADIntGuestInvitation [-AccessToken] <Object> [-EmailAddress] <String> [[-Message] <String>]
[<CommonParameters>]
DESCRIPTION
Invites an user to AAD using Azure Management API
PARAMETERS
-AccessToken <Object>
Auth Token
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailAddress <String>
Email address of the guest user
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Message <String>
The message to be sent with the invitation
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$cred=Get-Credential
PS C:\\>Get-AADIntAccessTokenForAADIAMAPI -Credentials $cred
PS C:\\>New-AADIntGuestInvitation -EmailAddress someone@company.com -Message "Welcome to our Tenant!"
accountEnabled : True
usageLocation :
mailNickname : someone_company.com#EXT#
passwordProfile :
rolesEntity :
selectedGroupIds :
streetAddress :
city :
state :
country :
telephoneNumber :
mobile :
physicalDeliveryOfficeName :
postalCode :
authenticationPhoneNumber :
authenticationAlternativePhoneNumber :
authenticationEmail :
strongAuthenticationDetail : @{verificationDetail=}
defaultImageUrl :
ageGroup :
consentProvidedForMinor :
legalAgeGroupClassification :
objectId : e550c8f5-aff3-4eea-9d68-cff019fa850e
objectType : User
displayName : someone
userPrincipalName : someone_company.com#EXT#@company.onmicrosoft.com
thumbnailPhoto@odata.mediaContentType :
givenName :
surname :
mail : someone@company.com
dirSyncEnabled :
alternativeSecurityIds : {}
signInNamesInfo : {}
signInNames : {someone_company.com#EXT#@company.onmicrosoft.com}
ownedDevices :
jobTitle :
department :
displayUserPrincipalName :
hasThumbnail : False
imageUrl :
imageDataToUpload :
source :
sources :
sourceText :
userFlags :
deletionTimestamp :
permanentDeletionTime :
alternateEmailAddress :
manager :
userType : Guest
isThumbnailUpdated :
isAuthenticationContactInfoUpdated :
searchableDeviceKey : {}
displayEmail :
creationType : Invitation
userState : PendingAcceptance
otherMails : {someone@company.com}
RELATED LINKS
SYNOPSIS
Invites an user to AAD
SYNTAX
New-AADIntGuestInvitation [-AccessToken] <Object> [-EmailAddress] <String> [[-Message] <String>]
[<CommonParameters>]
DESCRIPTION
Invites an user to AAD using Azure Management API
PARAMETERS
-AccessToken <Object>
Auth Token
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EmailAddress <String>
Email address of the guest user
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Message <String>
The message to be sent with the invitation
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$cred=Get-Credential
PS C:\\>Get-AADIntAccessTokenForAADIAMAPI -Credentials $cred
PS C:\\>New-AADIntGuestInvitation -EmailAddress someone@company.com -Message "Welcome to our Tenant!"
accountEnabled : True
usageLocation :
mailNickname : someone_company.com#EXT#
passwordProfile :
rolesEntity :
selectedGroupIds :
streetAddress :
city :
state :
country :
telephoneNumber :
mobile :
physicalDeliveryOfficeName :
postalCode :
authenticationPhoneNumber :
authenticationAlternativePhoneNumber :
authenticationEmail :
strongAuthenticationDetail : @{verificationDetail=}
defaultImageUrl :
ageGroup :
consentProvidedForMinor :
legalAgeGroupClassification :
objectId : e550c8f5-aff3-4eea-9d68-cff019fa850e
objectType : User
displayName : someone
userPrincipalName : someone_company.com#EXT#@company.onmicrosoft.com
thumbnailPhoto@odata.mediaContentType :
givenName :
surname :
mail : someone@company.com
dirSyncEnabled :
alternativeSecurityIds : {}
signInNamesInfo : {}
signInNames : {someone_company.com#EXT#@company.onmicrosoft.com}
ownedDevices :
jobTitle :
department :
displayUserPrincipalName :
hasThumbnail : False
imageUrl :
imageDataToUpload :
source :
sources :
sourceText :
userFlags :
deletionTimestamp :
permanentDeletionTime :
alternateEmailAddress :
manager :
userType : Guest
isThumbnailUpdated :
isAuthenticationContactInfoUpdated :
searchableDeviceKey : {}
displayEmail :
creationType : Invitation
userState : PendingAcceptance
otherMails : {someone@company.com}
RELATED LINKS