Assign License to User
Assign a license or SKU to a user in Office 365. Click here for a list of all available licenses, products, product names, and plan names.
Input
| Field | Definition | Type | Required |
|---|---|---|---|
| User | |||
| Id or Username |
User ID or username of the Office 365 user. This is the user's User Principal Name (UPN). A UPN is formed by taking the username and domain and combining them with the @ separator.
For example, |
String | TRUE |
| License | |||
| SKU Id | Unique identifier for the SKU / License. You can retrieve the available licenses for your Office 365 instance by using the 'Get Licenses' action. | String | TRUE |
| Disabled Plans | Collection of the unique identifiers for plans that have been disabled. You can retrieve the available plans for your SKUs / licenses by using the 'Get Licenses' action. | List of text | FALSE |
Output
| Field | Definition | Type |
|---|---|---|
| User | ||
| About Me | Field for the user to describe themselves. | String |
| Account Enabled | true if the account is enabled; otherwise, false. |
Boolean |
| Age Group | Age group of the user. Allowed values: null, minor, notAdult, and adult. |
String |
| Assigned Licenses | Licenses that are assigned to the user. | List of objects |
| Assigned Plans | Plans that are assigned to the user. | List of objects |
| Birthday |
Birthday of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 is: |
String |
| Business Phones |
Telephone numbers for the user.
Note: Although this is a string collection, only one number can be set for this property. |
List of text |
| City | City in which the user is located. | String |
| Company Name | Company name with which the user is associated. This property can be useful for describing the company from which an external user came. | String |
| Consent Provided For Minor | Whether consent has been obtained for minors. Allowed values: null, granted, denied, and notRequired. |
String |
| Country | The country or region in which the user is located. For example, US or UK. |
String |
| Created Date Time | Created date of the user object. | String |
| Department | Name of the department in which the user works. | String |
| Display Name | Name displayed in the address book for the user. This is usually the combination of the user's first name, middle initial, and last name. | String |
| Employee Id | Employee identifier assigned to the user by the organization. | String |
| Fax Number | Fax number of the user. | String |
| Given Name | Given name (first name) of the user. | String |
| Hire Date |
The hire date of the user. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 would look like this: |
String |
| Id | Unique identifier for the user. | String |
| Im Addresses | Instant message voice over IP (VOIP) session initiation protocol (SIP) addresses for the user. | List of text |
| Interests | List of the user's interests. | List of text |
| Is Resource Account | true if the user is a resource account; otherwise, false. null value should be considered false. |
Boolean |
| Job Title | User’s job title. | String |
| Legal Age Group Classification | Used by enterprise applications to determine the legal age group of the user. This property is read-only and calculated based on ageGroup and consentProvidedForMinor properties. Allowed values: null, minorWithOutParentalConsent, minorWithParentalConsent, minorNoParentalConsentRequired, notAdult, and adult. |
String |
| License Assignment States | State of license assignments for this user. | List of objects |
|
SMTP address for the user.
For example, |
String | |
| Mail Nickname | Mail alias for the user. | String |
| Mobile Phone | Primary cellular telephone number for the user. | String |
| My Site | URL for the user's personal site. | String |
| Office Location | Office location in the user's place of business. | String |
| On Premises Distinguished Name | Contains the on-premises Active Directory distinguished name or DN. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory using Azure AD Connect. |
String |
| On Premises Domain Name | Contains the on-premises domainFQDN, also called dnsDomainName, synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory using Azure AD Connect. | String |
| On Premises Extension Attributes | Contains extensionAttributes 1-15 for the user. Note that the individual extension attributes are neither selectable nor filterable. For an onPremisesSyncEnabled user, this set of properties is on-premises-sourced and is read-only. For a cloud-only user (where onPremisesSyncEnabled is false), these properties may be set during creation or update. | Object |
| On Premises Immutable Id | Property is used to associate an on-premises Active Directory user account to their Azure AD user object. This property must be specified when creating a new user account in the Graph if you are using a federated domain for the user’s userPrincipalName (UPN) property. | String |
| On Premises Last Sync Date Time |
Last time at which the object was synced with the on-premises directory; for example: 2013-02-16T03:04:54Z. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time.
For example, midnight UTC on Jan 1, 2014 would look like this: |
String |
| On Premises Provisioning Errors | Errors when using Microsoft synchronization product during provisioning. | List of objects |
| On Premises Sam Account Name | Contains the on-premises samAccountName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory using Azure AD Connect. | String |
| On Premises Security Identifier | Contains the on-premises security identifier (SID) for the user that was synchronized from on-premises to the cloud. | String |
| On Premises Sync Enabled | true if this object is synced from an on-premises directory; false if this object was originally synced from an on-premises directory but is no longer synced; null if this object has never been synced from an on-premises directory (default). |
Boolean |
| On Premises User Principal Name | Contains the on-premises userPrincipalName synchronized from the on-premises directory. The property is only populated for customers who are synchronizing their on-premises directory to Azure Active Directory using Azure AD Connect. | String |
| Other Mails | List of additional email addresses for the user. | String |
| Password Policies | Specifies password policies for the user. This value is an enumeration with one possible value being “DisableStrongPassword”, which allows weaker passwords than the default policy to be specified. “DisablePasswordExpiration” can also be specified. The two may be specified together; for example: "DisablePasswordExpiration, DisableStrongPassword". | String |
| Password Profile | Password profile for the user. The profile contains the user’s password. This property is required when a user is created. The password in the profile must satisfy minimum requirements as specified by the passwordPolicies property. By default, a strong password is required. | Object |
| Past Projects | List for the user to enumerate their past projects | List of text |
| Postal Code |
Postal code for the user's postal address. The postal code is specific to the user's country or region.
For example, in the United States of America, this attribute contains the ZIP code. |
String |
| Preferred Data Location | Preferred data location for the user. | String |
| Preferred Language |
The preferred language for the user. Should follow ISO 639-1 Code.
For example |
String |
| Preferred Name | Preferred name for the user. | String |
| Provisioned Plans | Plans that are provisioned for the user. | List of objects |
| Proxy Address |
List of user proxy addresses.
For example: |
List of text |
| Responsibilities | List for the user to enumerate their responsibilities | List of text |
| Schools | List for the user to enumerate the schools they have attended. | List of text |
| Show In Address List | true if the Outlook global address list should contain this user, otherwise false. If not set, this will be treated as true. For users invited through the invitation manager, this property will be set to false. |
Boolean |
| Skills | List for the user to enumerate their skills. | List of text |
| Sign In Sessions Valid From Date Time | Any refresh tokens or sessions tokens (session cookies) issued before this time are invalid, and applications will get an error when using an invalid refresh or sessions token to acquire a delegated access token (to access APIs such as Microsoft Graph). If this happens, the application will need to acquire a new refresh token by making a request to the authorize endpoint. | String |
| State | State or province in the user's address. | String |
| Street Address | Street address of the user's place of business. | String |
| Surname | User's surname (family name or last name). | String |
| Usage Location |
Two letter country code (ISO standard 3166). Required for users that will be assigned licenses due to legal requirement to check for availability of services in countries.
For examples include: |
String |
| User Principal Name | User principal name (UPN; also known as Username) of the user. The UPN is an Internet-style login name for the user based on the Internet standard RFC 822. By convention, this should map to the user's email name. The general format is alias@domain, where domain must be present in the tenant’s collection of verified domains. |
String |
| User Type | String value that can be used to classify user types in your directory, such as Member and Guest. |
String |