Documentation
¶
Index ¶
- type AddIn
- type AddInKeyValue
- type ApiPreAuthorizedApplication
- type AppRole
- type Application
- type ApplicationApi
- type ApplicationWeb
- type Domain
- type DomainState
- type EmailAddress
- type Group
- type GroupAssignedLabel
- type GroupAssignedLicense
- type GroupOnPremisesProvisioningError
- type ImplicitGrantSettings
- type InformationalUrl
- type Invitation
- type InvitedUserMessageInfo
- type KerberosSignOnSettings
- type KeyCredential
- type Me
- type OnPremisesPublishing
- type OnPremisesPublishingSingleSignOn
- type OnPremisesPublishingVerifiedCustomDomainCertificatesMetadata
- type OptionalClaim
- type OptionalClaims
- type ParentalControlSettings
- type PasswordCredential
- type PasswordSingleSignOnSettings
- type PermissionScope
- type PublicClient
- type Recipient
- type RequiredResourceAccess
- type ResourceAccess
- type SamlSingleSignOnSettings
- type ServicePrincipal
- type SignInAudience
- type SingleSignOnField
- type User
- type UserPasswordProfile
- type VerifiedPublisher
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddIn ¶
type AddIn struct {
ID *string `json:"id,omitempty"`
Properties *[]AddInKeyValue `json:"properties,omitempty"`
Type *string `json:"type,omitempty"`
}
type AddInKeyValue ¶
type ApiPreAuthorizedApplication ¶ added in v0.5.0
type AppRole ¶ added in v0.5.0
type AppRole struct {
ID *string `json:"id,omitempty"`
AllowedMemberTypes *[]string `json:"allowedMemberTypes,omitempty"`
Description *string `json:"description,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
IsEnabled *bool `json:"isEnabled,omitempty"`
Origin *string `json:"origin,omitempty"`
Value *string `json:"value,omitempty"`
}
type Application ¶
type Application struct {
ID *string `json:"id,omitempty"`
AddIns *[]AddIn `json:"addIns,omitempty"`
Api *ApplicationApi `json:"api,omitempty"`
AppId *string `json:"appId,omitempty"`
AppRoles *[]AppRole `json:"appRoles,omitempty"`
CreatedDateTime *time.Time `json:"createdDateTime,omitempty"`
DeletedDateTime *time.Time `json:"deletedDateTime,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
GroupMembershipClaims *string `json:"groupMembershipClaims,omitempty"`
IdentifierUris *[]string `json:"identifierUris,omitempty"`
Info *InformationalUrl `json:"info,omitempty"`
IsFallbackPublicClient *bool `json:"isFallbackPublicCLient,omitempty"`
KeyCredentials *[]KeyCredential `json:"keyCredentials,omitempty"`
Oauth2RequiredPostResponse *bool `json:"oauth2RequiredPostResponse,omitempty"`
OnPremisesPublishing *OnPremisesPublishing `json:"onPremisePublishing,omitempty"`
OptionalClaims *OptionalClaims `json:"optionalClaims,omitempty"`
ParentalControlSettings *ParentalControlSettings `json:"parentalControlSettings,omitempty"`
PasswordCredentials *[]PasswordCredential `json:"passwordCredentials,omitempty"`
PublicClient *PublicClient `json:"publicClient,omitempty"`
PublisherDomain *string `json:"publisherDomain,omitempty"`
RequiredResourceAccess *[]RequiredResourceAccess `json:"requiredResourceAccess,omitempty"`
SignInAudience SignInAudience `json:"signInAudience,omitempty"`
Tags *[]string `json:"tags,omitempty"`
TokenEncryptionKeyId *string `json:"tokenEncryptionKeyId,omitempty"`
Web *ApplicationWeb `json:"web,omitempty"`
Owners *[]string `json:"owners@odata.bind,omitempty"`
}
Application describes an Application object.
func (*Application) AppendAppRole ¶
func (a *Application) AppendAppRole(role AppRole) error
AppendAppRole adds a new AppRole to an Application, checking to see if it already exists.
func (*Application) AppendOwner ¶
func (a *Application) AppendOwner(endpoint environments.ApiEndpoint, apiVersion base.ApiVersion, id string)
AppendOwner appends a new owner object URI to the Owners slice.
func (*Application) RemoveAppRole ¶
func (a *Application) RemoveAppRole(role AppRole) error
RemoveAppRole removes an AppRole from an Application.
func (*Application) UpdateAppRole ¶
func (a *Application) UpdateAppRole(role AppRole) error
UpdateAppRole amends an existing AppRole defined in an Application.
type ApplicationApi ¶
type ApplicationApi struct {
AcceptMappedClaims *bool `json:"acceptMappedClaims,omitempty"`
KnownClientApplications *[]string `json:"knownClientApplications,omitempty"`
OAuth2PermissionScopes *[]PermissionScope `json:"oauth2PermissionScopes,omitempty"`
PreAuthorizedApplications *[]ApiPreAuthorizedApplication `json:"preAuthorizedApplications,omitempty"`
RequestedAccessTokenVersion *int32 `json:"requestedAccessTokenVersion,omitempty"`
}
func (*ApplicationApi) AppendOAuth2PermissionScope ¶ added in v0.3.0
func (a *ApplicationApi) AppendOAuth2PermissionScope(scope PermissionScope) error
AppendOAuth2PermissionScope adds a new ApplicationOAuth2PermissionScope to an ApplicationApi, checking to see if it already exists.
func (*ApplicationApi) RemoveOAuth2PermissionScope ¶ added in v0.3.0
func (a *ApplicationApi) RemoveOAuth2PermissionScope(scope PermissionScope) error
RemoveOAuth2PermissionScope removes an ApplicationOAuth2PermissionScope from an ApplicationApi.
func (*ApplicationApi) UpdateOAuth2PermissionScope ¶ added in v0.3.0
func (a *ApplicationApi) UpdateOAuth2PermissionScope(scope PermissionScope) error
UpdateOAuth2PermissionScope amends an existing ApplicationOAuth2PermissionScope defined in an ApplicationApi.
type ApplicationWeb ¶
type ApplicationWeb struct {
HomePageUrl *string `json:"homePageUrl"`
ImplicitGrantSettings *ImplicitGrantSettings `json:"implicitGrantSettings,omitempty"`
LogoutUrl *string `json:"logoutUrl"`
RedirectUris *[]string `json:"redirectUris,omitempty"`
}
type Domain ¶
type Domain struct {
ID *string `json:"id,omitempty"`
AuthenticationType *string `json:"authenticationType,omitempty"`
IsAdminManaged *bool `json:"isAdminManaged,omitempty"`
IsDefault *bool `json:"isDefault,omitempty"`
IsInitial *bool `json:"isInitial,omitempty"`
IsRoot *bool `json:"isRoot,omitempty"`
IsVerified *bool `json:"isVerified,omitempty"`
PasswordNotificationWindowInDays *int `json:"passwordNotificationWindowInDays,omitempty"`
PasswordValidityPeriodInDays *int `json:"passwordValidityPeriodInDays,omitempty"`
SupportedServices *[]string `json:"supportedServices,omitempty"`
State *DomainState `json:"state,omitempty"`
}
Domain describes a Domain object.
type DomainState ¶
type EmailAddress ¶ added in v0.9.0
type Group ¶
type Group struct {
ID *string `json:"id,omitempty"`
AllowExternalSenders *string `json:"allowExternalSenders,omitempty"`
AssignedLabels *[]GroupAssignedLabel `json:"assignedLabels,omitempty"`
AssignedLicenses *[]GroupAssignedLicense `json:"assignLicenses,omitempty"`
AutoSubscribeNewMembers *bool `json:"autoSubscribeNewMembers,omitempty"`
Classification *string `json:"classification,omitempty"`
CreatedDateTime *time.Time `json:"createdDateTime,omitempty"`
DeletedDateTime *time.Time `json:"deletedDateTime,omitempty"`
Description *string `json:"description,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
ExpirationDateTime *time.Time `json:"expirationDateTime,omitempty"`
GroupTypes *[]string `json:"groupTypes,omitempty"`
HasMembersWithLicenseErrors *bool `json:"hasMembersWithLicenseErrors,omitempty"`
HideFromAddressLists *bool `json:"hideFromAddressLists,omitempty"`
HideFromOutlookClients *bool `json:"hideFromOutlookClients,omitempty"`
IsSubscribedByMail *bool `json:"isSubscribedByMail,omitempty"`
LicenseProcessingState *string `json:"licenseProcessingState,omitempty"`
Mail *string `json:"mail,omitempty"`
MailEnabled *bool `json:"mailEnabled,omitempty"`
MailNickname *string `json:"mailNickname,omitempty"`
MembershipRule *string `json:"membershipRule,omitempty"`
MembershipRuleProcessingState *string `json:"membershipRuleProcessingState,omitempty"`
OnPremisesDomainName *string `json:"onPremisesDomainName,omitempty"`
OnPremisesLastSyncDateTime *time.Time `json:"onPremisesLastSyncDateTime,omitempty"`
OnPremisesNetBiosName *string `json:"onPremisesNetBiosName,omitempty"`
OnPremisesProvisioningErrors *[]GroupOnPremisesProvisioningError `json:"onPremisesProvisioningErrors,omitempty"`
OnPremisesSamAccountName *string `json:"onPremisesSamAccountName,omitempty"`
OnPremisesSecurityIdentifier *string `json:"onPremisesSecurityIdentifier,omitempty"`
OnPremisesSyncEnabled *bool `json:"onPremisesSyncEnabled,omitempty"`
PreferredDataLocation *string `json:"preferredDataLocation,omitempty"`
PreferredLanguage *string `json:"preferredLanguage,omitempty"`
ProxyAddresses *[]string `json:"proxyAddresses,omitempty"`
RenewedDateTime *time.Time `json:"renewedDateTime,omitempty"`
SecurityEnabled *bool `json:"securityEnabled,omitempty"`
SecurityIdentifier *string `json:"securityIdentifier,omitempty"`
Theme *string `json:"theme,omitempty"`
UnseenCount *int `json:"unseenCount,omitempty"`
Visibility *string `json:"visibility,omitempty"`
Members *[]string `json:"members@odata.bind,omitempty"`
Owners *[]string `json:"owners@odata.bind,omitempty"`
}
Group describes a Group object.
func (*Group) AppendMember ¶
func (g *Group) AppendMember(endpoint environments.ApiEndpoint, apiVersion base.ApiVersion, id string)
AppendMember appends a new member object URI to the Members slice.
func (*Group) AppendOwner ¶
func (g *Group) AppendOwner(endpoint environments.ApiEndpoint, apiVersion base.ApiVersion, id string)
AppendOwner appends a new owner object URI to the Owners slice.
type GroupAssignedLabel ¶
type GroupAssignedLicense ¶
type ImplicitGrantSettings ¶ added in v0.5.0
type InformationalUrl ¶
type Invitation ¶ added in v0.9.0
type Invitation struct {
ID *string `json:"id,omitempty"`
InvitedUserDisplayName *string `json:"invitedUserDisplayName,omitempty"`
InvitedUserEmailAddress *string `json:"invitedUserEmailAddress,omitempty"`
SendInvitationMessage *bool `json:"sendInvitationMessage,omitempty"`
InviteRedirectURL *string `json:"inviteRedirectUrl,omitempty"`
InviteRedeemURL *string `json:"inviteRedeemUrl,omitempty"`
Status *string `json:"status,omitempty"`
InvitedUserType *string `json:"invitedUserType,omitempty"`
InvitedUserMessageInfo *InvitedUserMessageInfo `json:"invitedUserMessageInfo,omitempty"`
InvitedUser *User `json:"invitedUser,omitempty"`
}
Invitation describes a Invitation object.
type InvitedUserMessageInfo ¶ added in v0.9.0
type KerberosSignOnSettings ¶ added in v0.5.0
type KeyCredential ¶
type KeyCredential struct {
CustomKeyIdentifier *string `json:"customKeyIdentifier,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
EndDateTime *time.Time `json:"endDateTime,omitempty"`
KeyId *string `json:"keyId,omitempty"`
StartDateTime *time.Time `json:"startDateTime,omitempty"`
Type *string `json:"type,omitempty"`
Usage *string `json:"usage,omitempty"`
Key *string `json:"key,omitempty"`
}
KeyCredential describes a key (certificate) credential for an object.
type Me ¶
type Me struct {
ID *string `json:"id"`
DisplayName *string `json:"displayName"`
UserPrincipalName *string `json:"userPrincipalName"`
}
Me describes the authenticated user.
type OnPremisesPublishing ¶ added in v0.5.0
type OnPremisesPublishing struct {
AlternateUrl *string `json:"alternateUrl,omitempty"`
ApplicationServerTimeout *string `json:"applicationServerTimeout,omitempty"`
ApplicationType *string `json:"applicationType,omitempty"`
ExternalAuthenticationType *string `json:"externalAuthenticationType,omitempty"`
ExternalUrl *string `json:"externalUrl,omitempty"`
InternalUrl *string `json:"internalUrl,omitempty"`
IsHttpOnlyCookieEnabled *bool `json:"isHttpOnlyCookieEnabled,omitempty"`
IsOnPremPublishingEnabled *bool `json:"isOnPremPublishingEnabled,omitempty"`
IsPersistentCookieEnabled *bool `json:"isPersistentCookieEnabled,omitempty"`
IsSecureCookieEnabled *bool `json:"isSecureCookieEnabled,omitempty"`
IsTranslateHostHeaderEnabled *bool `json:"isTranslateHostHeaderEnabled,omitempty"`
IsTranslateLinksInBodyEnabled *bool `json:"isTranslateLinksInBodyEnabled,omitempty"`
SingleSignOnSettings *OnPremisesPublishingSingleSignOn `json:"singleSignOnSettings,omitempty"`
VerifiedCustomDomainCertificatesMetadata *OnPremisesPublishingVerifiedCustomDomainCertificatesMetadata `json:"verifiedCustomDomainCertificatesMetadata,omitempty"`
VerifiedCustomDomainKeyCredential *KeyCredential `json:"verifiedCustomDomainKeyCredential,omitempty"`
VerifiedCustomDomainPasswordCredential *PasswordCredential `json:"verifiedCustomDomainPasswordCredential,omitempty"`
}
type OnPremisesPublishingSingleSignOn ¶ added in v0.5.0
type OnPremisesPublishingSingleSignOn struct {
KerberosSignOnSettings *KerberosSignOnSettings `json:"kerberosSignOnSettings,omitempty"`
SingleSignOnMode *string `json:"singleSignOnMode,omitempty"`
}
type OnPremisesPublishingVerifiedCustomDomainCertificatesMetadata ¶ added in v0.5.0
type OnPremisesPublishingVerifiedCustomDomainCertificatesMetadata struct {
ExpiryDate *time.Time `json:"expiryDate,omitempty"`
IssueDate *time.Time `json:"issueDate,omitempty"`
IssuerName *string `json:"issuerName,omitempty"`
SubjectName *string `json:"subjectName,omitempty"`
Thumbprint *string `json:"thumbprint,omitempty"`
}
type OptionalClaim ¶ added in v0.5.0
type OptionalClaims ¶ added in v0.5.0
type OptionalClaims struct {
AccessToken *[]OptionalClaim `json:"accessToken,omitempty"`
IdToken *[]OptionalClaim `json:"idToken,omitempty"`
Saml2Token *[]OptionalClaim `json:"saml2Token,omitempty"`
}
type ParentalControlSettings ¶
type PasswordCredential ¶
type PasswordCredential struct {
CustomKeyIdentifier *string `json:"customKeyIdentifier,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
EndDateTime *time.Time `json:"endDateTime,omitempty"`
Hint *string `json:"hint,omitempty"`
KeyId *string `json:"keyId,omitempty"`
SecretText *string `json:"secretText,omitempty"`
StartDateTime *time.Time `json:"startDateTime,omitempty"`
}
PasswordCredential describes a password credential for an object.
type PasswordSingleSignOnSettings ¶
type PasswordSingleSignOnSettings struct {
Fields *[]SingleSignOnField `json:"fields,omitempty"`
}
type PermissionScope ¶
type PermissionScope struct {
ID *string `json:"id,omitempty"`
AdminConsentDescription *string `json:"adminConsentDescription,omitempty"`
AdminConsentDisplayName *string `json:"adminConsentDisplayName,omitempty"`
IsEnabled *bool `json:"isEnabled,omitempty"`
Type *string `json:"type,omitempty"`
UserConsentDescription *string `json:"userConsentDescription,omitempty"`
UserConsentDisplayName *string `json:"userConsentDisplayName,omitempty"`
Value *string `json:"value,omitempty"`
}
type PublicClient ¶ added in v0.5.0
type PublicClient struct {
RedirectUris *[]string `json:"redirectUris,omitempty"`
}
type Recipient ¶ added in v0.9.0
type Recipient struct {
EmailAddress *EmailAddress `json:"emailAddress,omitempty"`
}
type RequiredResourceAccess ¶ added in v0.5.0
type RequiredResourceAccess struct {
ResourceAccess *[]ResourceAccess `json:"resourceAccess,omitempty"`
ResourceAppId *string `json:"resourceAppId,omitempty"`
}
type ResourceAccess ¶ added in v0.5.0
type SamlSingleSignOnSettings ¶
type SamlSingleSignOnSettings struct {
RelayState *string `json:"relayState,omitempty"`
}
type ServicePrincipal ¶
type ServicePrincipal struct {
ID *string `json:"id,omitempty"`
AccountEnabled *bool `json:"accountEnabled,omitempty"`
AddIns *[]AddIn `json:"addIns,omitempty"`
AlternativeNames *[]string `json:"alternativeNames,omitempty"`
AppDisplayName *string `json:"appDisplayName,omitempty"`
AppId *string `json:"appId,omitempty"`
ApplicationTemplateId *string `json:"applicationTemplateId,omitempty"`
AppOwnerOrganizationId *string `json:"appOwnerOrganizationId,omitempty"`
AppRoleAssignmentRequired *bool `json:"appRoleAssignmentRequired,omitempty"`
AppRoles *[]AppRole `json:"appRoles,omitempty"`
DeletedDateTime *time.Time `json:"deletedDateTime,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
Homepage *string `json:"homepage,omitempty"`
Info *InformationalUrl `json:"info,omitempty"`
KeyCredentials *[]KeyCredential `json:"keyCredentials,omitempty"`
LoginUrl *string `json:"loginUrl,omitempty"`
LogoutUrl *string `json:"logoutUrl,omitempty"`
NotificationEmailAddresses *[]string `json:"notificationEmailAddresses,omitempty"`
PasswordCredentials *[]PasswordCredential `json:"passwordCredentials,omitempty"`
PasswordSingleSignOnSettings *PasswordSingleSignOnSettings `json:"passwordSingleSignOnSettings,omitempty"`
PreferredSingleSignOnMode *string `json:"preferredSingleSignOnMode,omitempty"`
PreferredTokenSigningKeyEndDateTime *time.Time `json:"preferredTokenSigningKeyEndDateTime,omitempty"`
PublishedPermissionScopes *[]PermissionScope `json:"publishedPermissionScopes,omitempty"`
ReplyUrls *[]string `json:"replyUrls,omitempty"`
SamlSingleSignOnSettings *SamlSingleSignOnSettings `json:"samlSingleSignOnSettings,omitempty"`
ServicePrincipalNames *[]string `json:"servicePrincipalNames,omitempty"`
ServicePrincipalType *string `json:"servicePrincipalType,omitempty"`
SignInAudience SignInAudience `json:"signInAudience,omitempty"`
Tags *[]string `json:"tags,omitempty"`
TokenEncryptionKeyId *string `json:"tokenEncryptionKeyId,omitempty"`
VerifiedPublisher *VerifiedPublisher `json:"verifiedPublisher,omitempty"`
Owners *[]string `json:"owners@odata.bind,omitempty"`
}
ServicePrincipal describes a Service Principal object.
func (*ServicePrincipal) AppendOwner ¶
func (a *ServicePrincipal) AppendOwner(endpoint string, apiVersion string, id string)
AppendOwner appends a new owner object URI to the Owners slice.
type SignInAudience ¶
type SignInAudience string
const ( SignInAudienceAzureADMyOrg SignInAudience = "AzureADMyOrg" SignInAudienceAzureADMultipleOrgs SignInAudience = "AzureADMultipleOrgs" SignInAudienceAzureADandPersonalMicrosoftAccount SignInAudience = "AzureADandPersonalMicrosoftAccount" )
type SingleSignOnField ¶
type User ¶
type User struct {
ID *string `json:"id,omitempty"`
AboutMe *string `json:"aboutMe,omitempty"`
AccountEnabled *bool `json:"accountEnabled,omitempty"`
BusinessPhones *[]string `json:"businessPhones,omitempty"`
City *string `json:"city,omitempty"`
CompanyName *string `json:"companyName,omitempty"`
Country *string `json:"country,omitempty"`
CreationType *string `json:"creationType,omitempty"`
Department *string `json:"department,omitempty"`
DisplayName *string `json:"displayName,omitempty"`
EmployeeId *string `json:"employeeId,omitempty"`
ExternalUserState *string `json:"externalUserState,omitempty"`
FaxNumber *string `json:"faxNumber,omitempty"`
GivenName *string `json:"givenName,omitempty"`
ImAddresses *[]string `json:"imAddresses,omitempty"`
Interests *[]string `json:"interests,omitempty"`
JobTitle *string `json:"jobTitle,omitempty"`
Mail *string `json:"mail,omitempty"`
MailNickname *string `json:"mailNickname,omitempty"`
MobilePhone *string `json:"mobilePhone,omitempty"`
MySite *string `json:"mySite,omitempty"`
OfficeLocation *string `json:"officeLocation,omitempty"`
OnPremisesDistinguishedName *string `json:"onPremisesDistinguishedName,omitempty"`
OnPremisesDomainName *string `json:"onPremisesDomainName,omitempty"`
OnPremisesImmutableId *string `json:"onPremisesImmutableId,omitempty"`
OnPremisesSamAccountName *string `json:"onPremisesSamAccountName,omitempty"`
OnPremisesSecurityIdentifier *string `json:"onPremisesSecurityIdentifier,omitempty"`
OnPremisesSyncEnabled *bool `json:"onPremisesSyncEnabled,omitempty"`
OnPremisesUserPrincipalName *string `json:"onPremisesUserPrincipalName,omitempty"`
OtherMails *[]string `json:"otherMails,omitempty"`
PasswordPolicies *string `json:"passwordPolicies,omitempty"`
PastProjects *[]string `json:"pastProjects,omitempty"`
PostalCode *string `json:"postalCode,omitempty"`
PreferredDataLocation *string `json:"preferredDataLocation,omitempty"`
PreferredLanguage *string `json:"preferredLanguage,omitempty"`
PreferredName *string `json:"preferredName,omitempty"`
ProxyAddresses *[]string `json:"proxyAddresses,omitempty"`
Responsibilities *[]string `json:"responsibilities,omitempty"`
Schools *[]string `json:"schools,omitempty"`
ShowInAddressList *bool `json:"showInAddressList,omitempty"`
Skills *[]string `json:"skills,omitempty"`
State *string `json:"state,omitempty"`
StreetAddress *string `json:"streetAddress,omitempty"`
Surname *string `json:"surname,omitempty"`
UsageLocation *string `json:"usageLocation,omitempty"`
UserPrincipalName *string `json:"userPrincipalName,omitempty"`
UserType *string `json:"userType,omitempty"`
PasswordProfile *UserPasswordProfile `json:"passwordProfile,omitempty"`
}
User describes a User object.