graphrbac

package
v63.3.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 18, 2022 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package graphrbac implements the Azure ARM Graphrbac service API version 1.6.

The Graph RBAC Management Client

Index

Constants

View Source
const (
	// DefaultBaseURI is the default URI used for the service Graphrbac
	DefaultBaseURI = "https://graph.windows.net"
)

Variables

This section is empty.

Functions

func UserAgent

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type ADGroup

type ADGroup struct {
	autorest.Response `json:"-"`
	// DisplayName - The display name of the group.
	DisplayName *string `json:"displayName,omitempty"`
	// MailEnabled - Whether the group is mail-enabled. Must be false. This is because only pure security groups can be created using the Graph API.
	MailEnabled *bool `json:"mailEnabled,omitempty"`
	// MailNickname - The mail alias for the group.
	MailNickname *string `json:"mailNickname,omitempty"`
	// SecurityEnabled - Whether the group is security-enable.
	SecurityEnabled *bool `json:"securityEnabled,omitempty"`
	// Mail - The primary email address of the group.
	Mail *string `json:"mail,omitempty"`
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// ObjectID - READ-ONLY; The object ID.
	ObjectID *string `json:"objectId,omitempty"`
	// DeletionTimestamp - READ-ONLY; The time at which the directory object was deleted.
	DeletionTimestamp *date.Time `json:"deletionTimestamp,omitempty"`
	// ObjectType - Possible values include: 'ObjectTypeDirectoryObject', 'ObjectTypeApplication', 'ObjectTypeGroup', 'ObjectTypeServicePrincipal', 'ObjectTypeUser'
	ObjectType ObjectType `json:"objectType,omitempty"`
}

ADGroup active Directory group information.

func (ADGroup) AsADGroup

func (ag ADGroup) AsADGroup() (*ADGroup, bool)

AsADGroup is the BasicDirectoryObject implementation for ADGroup.

func (ADGroup) AsApplication

func (ag ADGroup) AsApplication() (*Application, bool)

AsApplication is the BasicDirectoryObject implementation for ADGroup.

func (ADGroup) AsBasicDirectoryObject

func (ag ADGroup) AsBasicDirectoryObject() (BasicDirectoryObject, bool)

AsBasicDirectoryObject is the BasicDirectoryObject implementation for ADGroup.

func (ADGroup) AsDirectoryObject

func (ag ADGroup) AsDirectoryObject() (*DirectoryObject, bool)

AsDirectoryObject is the BasicDirectoryObject implementation for ADGroup.

func (ADGroup) AsServicePrincipal

func (ag ADGroup) AsServicePrincipal() (*ServicePrincipal, bool)

AsServicePrincipal is the BasicDirectoryObject implementation for ADGroup.

func (ADGroup) AsUser

func (ag ADGroup) AsUser() (*User, bool)

AsUser is the BasicDirectoryObject implementation for ADGroup.

func (ADGroup) MarshalJSON

func (ag ADGroup) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ADGroup.

func (*ADGroup) UnmarshalJSON

func (ag *ADGroup) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ADGroup struct.

type AddOwnerParameters

type AddOwnerParameters struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// URL - 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 *string `json:"url,omitempty"`
}

AddOwnerParameters request parameters for adding a owner to an application.

func (AddOwnerParameters) MarshalJSON

func (aop AddOwnerParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for AddOwnerParameters.

func (*AddOwnerParameters) UnmarshalJSON

func (aop *AddOwnerParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for AddOwnerParameters struct.

type AppRole

type AppRole struct {
	// ID - Unique role identifier inside the appRoles collection.
	ID *string `json:"id,omitempty"`
	// AllowedMemberTypes - 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.
	AllowedMemberTypes *[]string `json:"allowedMemberTypes,omitempty"`
	// Description - Permission help text that appears in the admin app assignment and consent experiences.
	Description *string `json:"description,omitempty"`
	// DisplayName - Display name for the permission that appears in the admin consent and app assignment experiences.
	DisplayName *string `json:"displayName,omitempty"`
	// IsEnabled - 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.
	IsEnabled *bool `json:"isEnabled,omitempty"`
	// Value - Specifies the value of the roles claim that the application should expect in the authentication and access tokens.
	Value *string `json:"value,omitempty"`
}

AppRole ...

type Application

type Application struct {
	autorest.Response `json:"-"`
	// AppID - The application ID.
	AppID *string `json:"appId,omitempty"`
	// AllowGuestsSignIn - A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
	AllowGuestsSignIn *bool `json:"allowGuestsSignIn,omitempty"`
	// AllowPassthroughUsers - Indicates that the application supports pass through users who have no presence in the resource tenant.
	AllowPassthroughUsers *bool `json:"allowPassthroughUsers,omitempty"`
	// AppLogoURL - The url for the application logo image stored in a CDN.
	AppLogoURL *string `json:"appLogoUrl,omitempty"`
	// AppRoles - The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
	AppRoles *[]AppRole `json:"appRoles,omitempty"`
	// AppPermissions - The application permissions.
	AppPermissions *[]string `json:"appPermissions,omitempty"`
	// AvailableToOtherTenants - Whether the application is available to other tenants.
	AvailableToOtherTenants *bool `json:"availableToOtherTenants,omitempty"`
	// DisplayName - The display name of the application.
	DisplayName *string `json:"displayName,omitempty"`
	// ErrorURL - A URL provided by the author of the application to report errors when using the application.
	ErrorURL *string `json:"errorUrl,omitempty"`
	// GroupMembershipClaims - Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects. Possible values include: 'None', 'SecurityGroup', 'All'
	GroupMembershipClaims GroupMembershipClaimTypes `json:"groupMembershipClaims,omitempty"`
	// Homepage - The home page of the application.
	Homepage *string `json:"homepage,omitempty"`
	// IdentifierUris - A collection of URIs for the application.
	IdentifierUris *[]string `json:"identifierUris,omitempty"`
	// InformationalUrls - URLs with more information about the application.
	InformationalUrls *InformationalURL `json:"informationalUrls,omitempty"`
	// IsDeviceOnlyAuthSupported - Specifies whether this application supports device authentication without a user. The default is false.
	IsDeviceOnlyAuthSupported *bool `json:"isDeviceOnlyAuthSupported,omitempty"`
	// KeyCredentials - A collection of KeyCredential objects.
	KeyCredentials *[]KeyCredential `json:"keyCredentials,omitempty"`
	// KnownClientApplications - 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).
	KnownClientApplications *[]string `json:"knownClientApplications,omitempty"`
	// LogoutURL - the url of the logout page
	LogoutURL *string `json:"logoutUrl,omitempty"`
	// Oauth2AllowImplicitFlow - Whether to allow implicit grant flow for OAuth2
	Oauth2AllowImplicitFlow *bool `json:"oauth2AllowImplicitFlow,omitempty"`
	// Oauth2AllowURLPathMatching - 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.
	Oauth2AllowURLPathMatching *bool `json:"oauth2AllowUrlPathMatching,omitempty"`
	// Oauth2Permissions - 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.
	Oauth2Permissions *[]OAuth2Permission `json:"oauth2Permissions,omitempty"`
	// Oauth2RequirePostResponse - 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.
	Oauth2RequirePostResponse *bool `json:"oauth2RequirePostResponse,omitempty"`
	// OrgRestrictions - A list of tenants allowed to access application.
	OrgRestrictions *[]string       `json:"orgRestrictions,omitempty"`
	OptionalClaims  *OptionalClaims `json:"optionalClaims,omitempty"`
	// PasswordCredentials - A collection of PasswordCredential objects
	PasswordCredentials *[]PasswordCredential `json:"passwordCredentials,omitempty"`
	// PreAuthorizedApplications - list of pre-authorized applications.
	PreAuthorizedApplications *[]PreAuthorizedApplication `json:"preAuthorizedApplications,omitempty"`
	// PublicClient - Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
	PublicClient *bool `json:"publicClient,omitempty"`
	// PublisherDomain - Reliable domain which can be used to identify an application.
	PublisherDomain *string `json:"publisherDomain,omitempty"`
	// ReplyUrls - A collection of reply URLs for the application.
	ReplyUrls *[]string `json:"replyUrls,omitempty"`
	// RequiredResourceAccess - 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.
	RequiredResourceAccess *[]RequiredResourceAccess `json:"requiredResourceAccess,omitempty"`
	// SamlMetadataURL - The URL to the SAML metadata for the application.
	SamlMetadataURL *string `json:"samlMetadataUrl,omitempty"`
	// SignInAudience - Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
	SignInAudience *string `json:"signInAudience,omitempty"`
	// WwwHomepage - The primary Web page.
	WwwHomepage *string `json:"wwwHomepage,omitempty"`
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// ObjectID - READ-ONLY; The object ID.
	ObjectID *string `json:"objectId,omitempty"`
	// DeletionTimestamp - READ-ONLY; The time at which the directory object was deleted.
	DeletionTimestamp *date.Time `json:"deletionTimestamp,omitempty"`
	// ObjectType - Possible values include: 'ObjectTypeDirectoryObject', 'ObjectTypeApplication', 'ObjectTypeGroup', 'ObjectTypeServicePrincipal', 'ObjectTypeUser'
	ObjectType ObjectType `json:"objectType,omitempty"`
}

Application active Directory application information.

func (Application) AsADGroup

func (a Application) AsADGroup() (*ADGroup, bool)

AsADGroup is the BasicDirectoryObject implementation for Application.

func (Application) AsApplication

func (a Application) AsApplication() (*Application, bool)

AsApplication is the BasicDirectoryObject implementation for Application.

func (Application) AsBasicDirectoryObject

func (a Application) AsBasicDirectoryObject() (BasicDirectoryObject, bool)

AsBasicDirectoryObject is the BasicDirectoryObject implementation for Application.

func (Application) AsDirectoryObject

func (a Application) AsDirectoryObject() (*DirectoryObject, bool)

AsDirectoryObject is the BasicDirectoryObject implementation for Application.

func (Application) AsServicePrincipal

func (a Application) AsServicePrincipal() (*ServicePrincipal, bool)

AsServicePrincipal is the BasicDirectoryObject implementation for Application.

func (Application) AsUser

func (a Application) AsUser() (*User, bool)

AsUser is the BasicDirectoryObject implementation for Application.

func (Application) MarshalJSON

func (a Application) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Application.

func (*Application) UnmarshalJSON

func (a *Application) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Application struct.

type ApplicationBase

type ApplicationBase struct {
	// AllowGuestsSignIn - A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
	AllowGuestsSignIn *bool `json:"allowGuestsSignIn,omitempty"`
	// AllowPassthroughUsers - Indicates that the application supports pass through users who have no presence in the resource tenant.
	AllowPassthroughUsers *bool `json:"allowPassthroughUsers,omitempty"`
	// AppLogoURL - The url for the application logo image stored in a CDN.
	AppLogoURL *string `json:"appLogoUrl,omitempty"`
	// AppRoles - The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
	AppRoles *[]AppRole `json:"appRoles,omitempty"`
	// AppPermissions - The application permissions.
	AppPermissions *[]string `json:"appPermissions,omitempty"`
	// AvailableToOtherTenants - Whether the application is available to other tenants.
	AvailableToOtherTenants *bool `json:"availableToOtherTenants,omitempty"`
	// ErrorURL - A URL provided by the author of the application to report errors when using the application.
	ErrorURL *string `json:"errorUrl,omitempty"`
	// GroupMembershipClaims - Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects. Possible values include: 'None', 'SecurityGroup', 'All'
	GroupMembershipClaims GroupMembershipClaimTypes `json:"groupMembershipClaims,omitempty"`
	// Homepage - The home page of the application.
	Homepage *string `json:"homepage,omitempty"`
	// InformationalUrls - URLs with more information about the application.
	InformationalUrls *InformationalURL `json:"informationalUrls,omitempty"`
	// IsDeviceOnlyAuthSupported - Specifies whether this application supports device authentication without a user. The default is false.
	IsDeviceOnlyAuthSupported *bool `json:"isDeviceOnlyAuthSupported,omitempty"`
	// KeyCredentials - A collection of KeyCredential objects.
	KeyCredentials *[]KeyCredential `json:"keyCredentials,omitempty"`
	// KnownClientApplications - 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).
	KnownClientApplications *[]string `json:"knownClientApplications,omitempty"`
	// LogoutURL - the url of the logout page
	LogoutURL *string `json:"logoutUrl,omitempty"`
	// Oauth2AllowImplicitFlow - Whether to allow implicit grant flow for OAuth2
	Oauth2AllowImplicitFlow *bool `json:"oauth2AllowImplicitFlow,omitempty"`
	// Oauth2AllowURLPathMatching - 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.
	Oauth2AllowURLPathMatching *bool `json:"oauth2AllowUrlPathMatching,omitempty"`
	// Oauth2Permissions - 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.
	Oauth2Permissions *[]OAuth2Permission `json:"oauth2Permissions,omitempty"`
	// Oauth2RequirePostResponse - 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.
	Oauth2RequirePostResponse *bool `json:"oauth2RequirePostResponse,omitempty"`
	// OrgRestrictions - A list of tenants allowed to access application.
	OrgRestrictions *[]string       `json:"orgRestrictions,omitempty"`
	OptionalClaims  *OptionalClaims `json:"optionalClaims,omitempty"`
	// PasswordCredentials - A collection of PasswordCredential objects
	PasswordCredentials *[]PasswordCredential `json:"passwordCredentials,omitempty"`
	// PreAuthorizedApplications - list of pre-authorized applications.
	PreAuthorizedApplications *[]PreAuthorizedApplication `json:"preAuthorizedApplications,omitempty"`
	// PublicClient - Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
	PublicClient *bool `json:"publicClient,omitempty"`
	// PublisherDomain - Reliable domain which can be used to identify an application.
	PublisherDomain *string `json:"publisherDomain,omitempty"`
	// ReplyUrls - A collection of reply URLs for the application.
	ReplyUrls *[]string `json:"replyUrls,omitempty"`
	// RequiredResourceAccess - 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.
	RequiredResourceAccess *[]RequiredResourceAccess `json:"requiredResourceAccess,omitempty"`
	// SamlMetadataURL - The URL to the SAML metadata for the application.
	SamlMetadataURL *string `json:"samlMetadataUrl,omitempty"`
	// SignInAudience - Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
	SignInAudience *string `json:"signInAudience,omitempty"`
	// WwwHomepage - The primary Web page.
	WwwHomepage *string `json:"wwwHomepage,omitempty"`
}

ApplicationBase active Directive Application common properties shared among GET, POST and PATCH

type ApplicationCreateParameters

type ApplicationCreateParameters struct {
	// DisplayName - The display name of the application.
	DisplayName *string `json:"displayName,omitempty"`
	// IdentifierUris - A collection of URIs for the application.
	IdentifierUris *[]string `json:"identifierUris,omitempty"`
	// AllowGuestsSignIn - A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
	AllowGuestsSignIn *bool `json:"allowGuestsSignIn,omitempty"`
	// AllowPassthroughUsers - Indicates that the application supports pass through users who have no presence in the resource tenant.
	AllowPassthroughUsers *bool `json:"allowPassthroughUsers,omitempty"`
	// AppLogoURL - The url for the application logo image stored in a CDN.
	AppLogoURL *string `json:"appLogoUrl,omitempty"`
	// AppRoles - The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
	AppRoles *[]AppRole `json:"appRoles,omitempty"`
	// AppPermissions - The application permissions.
	AppPermissions *[]string `json:"appPermissions,omitempty"`
	// AvailableToOtherTenants - Whether the application is available to other tenants.
	AvailableToOtherTenants *bool `json:"availableToOtherTenants,omitempty"`
	// ErrorURL - A URL provided by the author of the application to report errors when using the application.
	ErrorURL *string `json:"errorUrl,omitempty"`
	// GroupMembershipClaims - Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects. Possible values include: 'None', 'SecurityGroup', 'All'
	GroupMembershipClaims GroupMembershipClaimTypes `json:"groupMembershipClaims,omitempty"`
	// Homepage - The home page of the application.
	Homepage *string `json:"homepage,omitempty"`
	// InformationalUrls - URLs with more information about the application.
	InformationalUrls *InformationalURL `json:"informationalUrls,omitempty"`
	// IsDeviceOnlyAuthSupported - Specifies whether this application supports device authentication without a user. The default is false.
	IsDeviceOnlyAuthSupported *bool `json:"isDeviceOnlyAuthSupported,omitempty"`
	// KeyCredentials - A collection of KeyCredential objects.
	KeyCredentials *[]KeyCredential `json:"keyCredentials,omitempty"`
	// KnownClientApplications - 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).
	KnownClientApplications *[]string `json:"knownClientApplications,omitempty"`
	// LogoutURL - the url of the logout page
	LogoutURL *string `json:"logoutUrl,omitempty"`
	// Oauth2AllowImplicitFlow - Whether to allow implicit grant flow for OAuth2
	Oauth2AllowImplicitFlow *bool `json:"oauth2AllowImplicitFlow,omitempty"`
	// Oauth2AllowURLPathMatching - 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.
	Oauth2AllowURLPathMatching *bool `json:"oauth2AllowUrlPathMatching,omitempty"`
	// Oauth2Permissions - 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.
	Oauth2Permissions *[]OAuth2Permission `json:"oauth2Permissions,omitempty"`
	// Oauth2RequirePostResponse - 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.
	Oauth2RequirePostResponse *bool `json:"oauth2RequirePostResponse,omitempty"`
	// OrgRestrictions - A list of tenants allowed to access application.
	OrgRestrictions *[]string       `json:"orgRestrictions,omitempty"`
	OptionalClaims  *OptionalClaims `json:"optionalClaims,omitempty"`
	// PasswordCredentials - A collection of PasswordCredential objects
	PasswordCredentials *[]PasswordCredential `json:"passwordCredentials,omitempty"`
	// PreAuthorizedApplications - list of pre-authorized applications.
	PreAuthorizedApplications *[]PreAuthorizedApplication `json:"preAuthorizedApplications,omitempty"`
	// PublicClient - Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
	PublicClient *bool `json:"publicClient,omitempty"`
	// PublisherDomain - Reliable domain which can be used to identify an application.
	PublisherDomain *string `json:"publisherDomain,omitempty"`
	// ReplyUrls - A collection of reply URLs for the application.
	ReplyUrls *[]string `json:"replyUrls,omitempty"`
	// RequiredResourceAccess - 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.
	RequiredResourceAccess *[]RequiredResourceAccess `json:"requiredResourceAccess,omitempty"`
	// SamlMetadataURL - The URL to the SAML metadata for the application.
	SamlMetadataURL *string `json:"samlMetadataUrl,omitempty"`
	// SignInAudience - Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
	SignInAudience *string `json:"signInAudience,omitempty"`
	// WwwHomepage - The primary Web page.
	WwwHomepage *string `json:"wwwHomepage,omitempty"`
}

ApplicationCreateParameters request parameters for creating a new application.

type ApplicationListResult

type ApplicationListResult struct {
	autorest.Response `json:"-"`
	// Value - A collection of applications.
	Value *[]Application `json:"value,omitempty"`
	// OdataNextLink - The URL to get the next set of results.
	OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

ApplicationListResult application list operation result.

func (ApplicationListResult) IsEmpty

func (alr ApplicationListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ApplicationListResultIterator

type ApplicationListResultIterator struct {
	// contains filtered or unexported fields
}

ApplicationListResultIterator provides access to a complete listing of Application values.

func NewApplicationListResultIterator

func NewApplicationListResultIterator(page ApplicationListResultPage) ApplicationListResultIterator

Creates a new instance of the ApplicationListResultIterator type.

func (*ApplicationListResultIterator) Next

func (iter *ApplicationListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ApplicationListResultIterator) NextWithContext

func (iter *ApplicationListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ApplicationListResultIterator) NotDone

func (iter ApplicationListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (ApplicationListResultIterator) Response

Response returns the raw server response from the last page request.

func (ApplicationListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ApplicationListResultPage

type ApplicationListResultPage struct {
	// contains filtered or unexported fields
}

ApplicationListResultPage contains a page of Application values.

func NewApplicationListResultPage

Creates a new instance of the ApplicationListResultPage type.

func (*ApplicationListResultPage) Next

func (page *ApplicationListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ApplicationListResultPage) NextWithContext

func (page *ApplicationListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ApplicationListResultPage) NotDone

func (page ApplicationListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ApplicationListResultPage) Response

Response returns the raw server response from the last page request.

func (ApplicationListResultPage) Values

func (page ApplicationListResultPage) Values() []Application

Values returns the slice of values for the current page or nil if there are no values.

type ApplicationUpdateParameters

type ApplicationUpdateParameters struct {
	// DisplayName - The display name of the application.
	DisplayName *string `json:"displayName,omitempty"`
	// IdentifierUris - A collection of URIs for the application.
	IdentifierUris *[]string `json:"identifierUris,omitempty"`
	// AllowGuestsSignIn - A property on the application to indicate if the application accepts other IDPs or not or partially accepts.
	AllowGuestsSignIn *bool `json:"allowGuestsSignIn,omitempty"`
	// AllowPassthroughUsers - Indicates that the application supports pass through users who have no presence in the resource tenant.
	AllowPassthroughUsers *bool `json:"allowPassthroughUsers,omitempty"`
	// AppLogoURL - The url for the application logo image stored in a CDN.
	AppLogoURL *string `json:"appLogoUrl,omitempty"`
	// AppRoles - The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
	AppRoles *[]AppRole `json:"appRoles,omitempty"`
	// AppPermissions - The application permissions.
	AppPermissions *[]string `json:"appPermissions,omitempty"`
	// AvailableToOtherTenants - Whether the application is available to other tenants.
	AvailableToOtherTenants *bool `json:"availableToOtherTenants,omitempty"`
	// ErrorURL - A URL provided by the author of the application to report errors when using the application.
	ErrorURL *string `json:"errorUrl,omitempty"`
	// GroupMembershipClaims - Configures the groups claim issued in a user or OAuth 2.0 access token that the app expects. Possible values include: 'None', 'SecurityGroup', 'All'
	GroupMembershipClaims GroupMembershipClaimTypes `json:"groupMembershipClaims,omitempty"`
	// Homepage - The home page of the application.
	Homepage *string `json:"homepage,omitempty"`
	// InformationalUrls - URLs with more information about the application.
	InformationalUrls *InformationalURL `json:"informationalUrls,omitempty"`
	// IsDeviceOnlyAuthSupported - Specifies whether this application supports device authentication without a user. The default is false.
	IsDeviceOnlyAuthSupported *bool `json:"isDeviceOnlyAuthSupported,omitempty"`
	// KeyCredentials - A collection of KeyCredential objects.
	KeyCredentials *[]KeyCredential `json:"keyCredentials,omitempty"`
	// KnownClientApplications - 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).
	KnownClientApplications *[]string `json:"knownClientApplications,omitempty"`
	// LogoutURL - the url of the logout page
	LogoutURL *string `json:"logoutUrl,omitempty"`
	// Oauth2AllowImplicitFlow - Whether to allow implicit grant flow for OAuth2
	Oauth2AllowImplicitFlow *bool `json:"oauth2AllowImplicitFlow,omitempty"`
	// Oauth2AllowURLPathMatching - 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.
	Oauth2AllowURLPathMatching *bool `json:"oauth2AllowUrlPathMatching,omitempty"`
	// Oauth2Permissions - 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.
	Oauth2Permissions *[]OAuth2Permission `json:"oauth2Permissions,omitempty"`
	// Oauth2RequirePostResponse - 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.
	Oauth2RequirePostResponse *bool `json:"oauth2RequirePostResponse,omitempty"`
	// OrgRestrictions - A list of tenants allowed to access application.
	OrgRestrictions *[]string       `json:"orgRestrictions,omitempty"`
	OptionalClaims  *OptionalClaims `json:"optionalClaims,omitempty"`
	// PasswordCredentials - A collection of PasswordCredential objects
	PasswordCredentials *[]PasswordCredential `json:"passwordCredentials,omitempty"`
	// PreAuthorizedApplications - list of pre-authorized applications.
	PreAuthorizedApplications *[]PreAuthorizedApplication `json:"preAuthorizedApplications,omitempty"`
	// PublicClient - Specifies whether this application is a public client (such as an installed application running on a mobile device). Default is false.
	PublicClient *bool `json:"publicClient,omitempty"`
	// PublisherDomain - Reliable domain which can be used to identify an application.
	PublisherDomain *string `json:"publisherDomain,omitempty"`
	// ReplyUrls - A collection of reply URLs for the application.
	ReplyUrls *[]string `json:"replyUrls,omitempty"`
	// RequiredResourceAccess - 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.
	RequiredResourceAccess *[]RequiredResourceAccess `json:"requiredResourceAccess,omitempty"`
	// SamlMetadataURL - The URL to the SAML metadata for the application.
	SamlMetadataURL *string `json:"samlMetadataUrl,omitempty"`
	// SignInAudience - Audience for signing in to the application (AzureADMyOrganization, AzureADAllOrganizations, AzureADAndMicrosoftAccounts).
	SignInAudience *string `json:"signInAudience,omitempty"`
	// WwwHomepage - The primary Web page.
	WwwHomepage *string `json:"wwwHomepage,omitempty"`
}

ApplicationUpdateParameters request parameters for updating a new application.

type ApplicationsClient

type ApplicationsClient struct {
	BaseClient
}

ApplicationsClient is the the Graph RBAC Management Client

func NewApplicationsClient

func NewApplicationsClient(tenantID string) ApplicationsClient

NewApplicationsClient creates an instance of the ApplicationsClient client.

func NewApplicationsClientWithBaseURI

func NewApplicationsClientWithBaseURI(baseURI string, tenantID string) ApplicationsClient

NewApplicationsClientWithBaseURI creates an instance of the ApplicationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ApplicationsClient) AddOwner

func (client ApplicationsClient) AddOwner(ctx context.Context, applicationObjectID string, parameters AddOwnerParameters) (result autorest.Response, err error)

AddOwner add an owner to an application. Parameters: applicationObjectID - the object ID of the application to which to add the owner. parameters - the URL of the owner object, such as https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd.

func (ApplicationsClient) AddOwnerPreparer

func (client ApplicationsClient) AddOwnerPreparer(ctx context.Context, applicationObjectID string, parameters AddOwnerParameters) (*http.Request, error)

AddOwnerPreparer prepares the AddOwner request.

func (ApplicationsClient) AddOwnerResponder

func (client ApplicationsClient) AddOwnerResponder(resp *http.Response) (result autorest.Response, err error)

AddOwnerResponder handles the response to the AddOwner request. The method always closes the http.Response Body.

func (ApplicationsClient) AddOwnerSender

func (client ApplicationsClient) AddOwnerSender(req *http.Request) (*http.Response, error)

AddOwnerSender sends the AddOwner request. The method will close the http.Response Body if it receives an error.

func (ApplicationsClient) Create

func (client ApplicationsClient) Create(ctx context.Context, parameters ApplicationCreateParameters) (result Application, err error)

Create create a new application. Parameters: parameters - the parameters for creating an application.

func (ApplicationsClient) CreatePreparer

func (client ApplicationsClient) CreatePreparer(ctx context.Context, parameters ApplicationCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ApplicationsClient) CreateResponder

func (client ApplicationsClient) CreateResponder(resp *http.Response) (result Application, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (ApplicationsClient) CreateSender

func (client ApplicationsClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (ApplicationsClient) Delete

func (client ApplicationsClient) Delete(ctx context.Context, applicationObjectID string) (result autorest.Response, err error)

Delete delete an application. Parameters: applicationObjectID - application object ID.

func (ApplicationsClient) DeletePreparer

func (client ApplicationsClient) DeletePreparer(ctx context.Context, applicationObjectID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ApplicationsClient) DeleteResponder

func (client ApplicationsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ApplicationsClient) DeleteSender

func (client ApplicationsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ApplicationsClient) Get

func (client ApplicationsClient) Get(ctx context.Context, applicationObjectID string) (result Application, err error)

Get get an application by object ID. Parameters: applicationObjectID - application object ID.

func (ApplicationsClient) GetPreparer

func (client ApplicationsClient) GetPreparer(ctx context.Context, applicationObjectID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ApplicationsClient) GetResponder

func (client ApplicationsClient) GetResponder(resp *http.Response) (result Application, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ApplicationsClient) GetSender

func (client ApplicationsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ApplicationsClient) GetServicePrincipalsIDByAppID

func (client ApplicationsClient) GetServicePrincipalsIDByAppID(ctx context.Context, applicationID string) (result ServicePrincipalObjectResult, err error)

GetServicePrincipalsIDByAppID gets an object id for a given application id from the current tenant. Parameters: applicationID - the application ID.

func (ApplicationsClient) GetServicePrincipalsIDByAppIDPreparer

func (client ApplicationsClient) GetServicePrincipalsIDByAppIDPreparer(ctx context.Context, applicationID string) (*http.Request, error)

GetServicePrincipalsIDByAppIDPreparer prepares the GetServicePrincipalsIDByAppID request.

func (ApplicationsClient) GetServicePrincipalsIDByAppIDResponder

func (client ApplicationsClient) GetServicePrincipalsIDByAppIDResponder(resp *http.Response) (result ServicePrincipalObjectResult, err error)

GetServicePrincipalsIDByAppIDResponder handles the response to the GetServicePrincipalsIDByAppID request. The method always closes the http.Response Body.

func (ApplicationsClient) GetServicePrincipalsIDByAppIDSender

func (client ApplicationsClient) GetServicePrincipalsIDByAppIDSender(req *http.Request) (*http.Response, error)

GetServicePrincipalsIDByAppIDSender sends the GetServicePrincipalsIDByAppID request. The method will close the http.Response Body if it receives an error.

func (ApplicationsClient) List

func (client ApplicationsClient) List(ctx context.Context, filter string) (result ApplicationListResultPage, err error)

List lists applications by filter parameters. Parameters: filter - the filters to apply to the operation.

func (ApplicationsClient) ListComplete

func (client ApplicationsClient) ListComplete(ctx context.Context, filter string) (result ApplicationListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (ApplicationsClient) ListKeyCredentials

func (client ApplicationsClient) ListKeyCredentials(ctx context.Context, applicationObjectID string) (result KeyCredentialListResult, err error)

ListKeyCredentials get the keyCredentials associated with an application. Parameters: applicationObjectID - application object ID.

func (ApplicationsClient) ListKeyCredentialsPreparer

func (client ApplicationsClient) ListKeyCredentialsPreparer(ctx context.Context, applicationObjectID string) (*http.Request, error)

ListKeyCredentialsPreparer prepares the ListKeyCredentials request.

func (ApplicationsClient) ListKeyCredentialsResponder

func (client ApplicationsClient) ListKeyCredentialsResponder(resp *http.Response) (result KeyCredentialListResult, err error)

ListKeyCredentialsResponder handles the response to the ListKeyCredentials request. The method always closes the http.Response Body.

func (ApplicationsClient) ListKeyCredentialsSender

func (client ApplicationsClient) ListKeyCredentialsSender(req *http.Request) (*http.Response, error)

ListKeyCredentialsSender sends the ListKeyCredentials request. The method will close the http.Response Body if it receives an error.

func (ApplicationsClient) ListNext

func (client ApplicationsClient) ListNext(ctx context.Context, nextLink string) (result ApplicationListResult, err error)

ListNext gets a list of applications from the current tenant. Parameters: nextLink - next link for the list operation.

func (ApplicationsClient) ListNextPreparer

func (client ApplicationsClient) ListNextPreparer(ctx context.Context, nextLink string) (*http.Request, error)

ListNextPreparer prepares the ListNext request.

func (ApplicationsClient) ListNextResponder

func (client ApplicationsClient) ListNextResponder(resp *http.Response) (result ApplicationListResult, err error)

ListNextResponder handles the response to the ListNext request. The method always closes the http.Response Body.

func (ApplicationsClient) ListNextSender

func (client ApplicationsClient) ListNextSender(req *http.Request) (*http.Response, error)

ListNextSender sends the ListNext request. The method will close the http.Response Body if it receives an error.

func (ApplicationsClient) ListOwners

func (client ApplicationsClient) ListOwners(ctx context.Context, applicationObjectID string) (result DirectoryObjectListResultPage, err error)

ListOwners the owners are a set of non-admin users who are allowed to modify this object. Parameters: applicationObjectID - the object ID of the application for which to get owners.

func (ApplicationsClient) ListOwnersComplete

func (client ApplicationsClient) ListOwnersComplete(ctx context.Context, applicationObjectID string) (result DirectoryObjectListResultIterator, err error)

ListOwnersComplete enumerates all values, automatically crossing page boundaries as required.

func (ApplicationsClient) ListOwnersPreparer

func (client ApplicationsClient) ListOwnersPreparer(ctx context.Context, applicationObjectID string) (*http.Request, error)

ListOwnersPreparer prepares the ListOwners request.

func (ApplicationsClient) ListOwnersResponder

func (client ApplicationsClient) ListOwnersResponder(resp *http.Response) (result DirectoryObjectListResult, err error)

ListOwnersResponder handles the response to the ListOwners request. The method always closes the http.Response Body.

func (ApplicationsClient) ListOwnersSender

func (client ApplicationsClient) ListOwnersSender(req *http.Request) (*http.Response, error)

ListOwnersSender sends the ListOwners request. The method will close the http.Response Body if it receives an error.

func (ApplicationsClient) ListPasswordCredentials

func (client ApplicationsClient) ListPasswordCredentials(ctx context.Context, applicationObjectID string) (result PasswordCredentialListResult, err error)

ListPasswordCredentials get the passwordCredentials associated with an application. Parameters: applicationObjectID - application object ID.

func (ApplicationsClient) ListPasswordCredentialsPreparer

func (client ApplicationsClient) ListPasswordCredentialsPreparer(ctx context.Context, applicationObjectID string) (*http.Request, error)

ListPasswordCredentialsPreparer prepares the ListPasswordCredentials request.

func (ApplicationsClient) ListPasswordCredentialsResponder

func (client ApplicationsClient) ListPasswordCredentialsResponder(resp *http.Response) (result PasswordCredentialListResult, err error)

ListPasswordCredentialsResponder handles the response to the ListPasswordCredentials request. The method always closes the http.Response Body.

func (ApplicationsClient) ListPasswordCredentialsSender

func (client ApplicationsClient) ListPasswordCredentialsSender(req *http.Request) (*http.Response, error)

ListPasswordCredentialsSender sends the ListPasswordCredentials request. The method will close the http.Response Body if it receives an error.

func (ApplicationsClient) ListPreparer

func (client ApplicationsClient) ListPreparer(ctx context.Context, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (ApplicationsClient) ListResponder

func (client ApplicationsClient) ListResponder(resp *http.Response) (result ApplicationListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ApplicationsClient) ListSender

func (client ApplicationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (ApplicationsClient) Patch

func (client ApplicationsClient) Patch(ctx context.Context, applicationObjectID string, parameters ApplicationUpdateParameters) (result autorest.Response, err error)

Patch update an existing application. Parameters: applicationObjectID - application object ID. parameters - parameters to update an existing application.

func (ApplicationsClient) PatchPreparer

func (client ApplicationsClient) PatchPreparer(ctx context.Context, applicationObjectID string, parameters ApplicationUpdateParameters) (*http.Request, error)

PatchPreparer prepares the Patch request.

func (ApplicationsClient) PatchResponder

func (client ApplicationsClient) PatchResponder(resp *http.Response) (result autorest.Response, err error)

PatchResponder handles the response to the Patch request. The method always closes the http.Response Body.

func (ApplicationsClient) PatchSender

func (client ApplicationsClient) PatchSender(req *http.Request) (*http.Response, error)

PatchSender sends the Patch request. The method will close the http.Response Body if it receives an error.

func (ApplicationsClient) RemoveOwner

func (client ApplicationsClient) RemoveOwner(ctx context.Context, applicationObjectID string, ownerObjectID string) (result autorest.Response, err error)

RemoveOwner remove a member from owners. Parameters: applicationObjectID - the object ID of the application from which to remove the owner. ownerObjectID - owner object id

func (ApplicationsClient) RemoveOwnerPreparer

func (client ApplicationsClient) RemoveOwnerPreparer(ctx context.Context, applicationObjectID string, ownerObjectID string) (*http.Request, error)

RemoveOwnerPreparer prepares the RemoveOwner request.

func (ApplicationsClient) RemoveOwnerResponder

func (client ApplicationsClient) RemoveOwnerResponder(resp *http.Response) (result autorest.Response, err error)

RemoveOwnerResponder handles the response to the RemoveOwner request. The method always closes the http.Response Body.

func (ApplicationsClient) RemoveOwnerSender

func (client ApplicationsClient) RemoveOwnerSender(req *http.Request) (*http.Response, error)

RemoveOwnerSender sends the RemoveOwner request. The method will close the http.Response Body if it receives an error.

func (ApplicationsClient) UpdateKeyCredentials

func (client ApplicationsClient) UpdateKeyCredentials(ctx context.Context, applicationObjectID string, parameters KeyCredentialsUpdateParameters) (result autorest.Response, err error)

UpdateKeyCredentials update the keyCredentials associated with an application. Parameters: applicationObjectID - application object ID. parameters - parameters to update the keyCredentials of an existing application.

func (ApplicationsClient) UpdateKeyCredentialsPreparer

func (client ApplicationsClient) UpdateKeyCredentialsPreparer(ctx context.Context, applicationObjectID string, parameters KeyCredentialsUpdateParameters) (*http.Request, error)

UpdateKeyCredentialsPreparer prepares the UpdateKeyCredentials request.

func (ApplicationsClient) UpdateKeyCredentialsResponder

func (client ApplicationsClient) UpdateKeyCredentialsResponder(resp *http.Response) (result autorest.Response, err error)

UpdateKeyCredentialsResponder handles the response to the UpdateKeyCredentials request. The method always closes the http.Response Body.

func (ApplicationsClient) UpdateKeyCredentialsSender

func (client ApplicationsClient) UpdateKeyCredentialsSender(req *http.Request) (*http.Response, error)

UpdateKeyCredentialsSender sends the UpdateKeyCredentials request. The method will close the http.Response Body if it receives an error.

func (ApplicationsClient) UpdatePasswordCredentials

func (client ApplicationsClient) UpdatePasswordCredentials(ctx context.Context, applicationObjectID string, parameters PasswordCredentialsUpdateParameters) (result autorest.Response, err error)

UpdatePasswordCredentials update passwordCredentials associated with an application. Parameters: applicationObjectID - application object ID. parameters - parameters to update passwordCredentials of an existing application.

func (ApplicationsClient) UpdatePasswordCredentialsPreparer

func (client ApplicationsClient) UpdatePasswordCredentialsPreparer(ctx context.Context, applicationObjectID string, parameters PasswordCredentialsUpdateParameters) (*http.Request, error)

UpdatePasswordCredentialsPreparer prepares the UpdatePasswordCredentials request.

func (ApplicationsClient) UpdatePasswordCredentialsResponder

func (client ApplicationsClient) UpdatePasswordCredentialsResponder(resp *http.Response) (result autorest.Response, err error)

UpdatePasswordCredentialsResponder handles the response to the UpdatePasswordCredentials request. The method always closes the http.Response Body.

func (ApplicationsClient) UpdatePasswordCredentialsSender

func (client ApplicationsClient) UpdatePasswordCredentialsSender(req *http.Request) (*http.Response, error)

UpdatePasswordCredentialsSender sends the UpdatePasswordCredentials request. The method will close the http.Response Body if it receives an error.

type BaseClient

type BaseClient struct {
	autorest.Client
	BaseURI  string
	TenantID string
}

BaseClient is the base client for Graphrbac.

func New

func New(tenantID string) BaseClient

New creates an instance of the BaseClient client.

func NewWithBaseURI

func NewWithBaseURI(baseURI string, tenantID string) BaseClient

NewWithBaseURI creates an instance of the BaseClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

type BasicDirectoryObject

type BasicDirectoryObject interface {
	AsApplication() (*Application, bool)
	AsADGroup() (*ADGroup, bool)
	AsServicePrincipal() (*ServicePrincipal, bool)
	AsUser() (*User, bool)
	AsDirectoryObject() (*DirectoryObject, bool)
}

BasicDirectoryObject represents an Azure Active Directory object.

type CheckGroupMembershipParameters

type CheckGroupMembershipParameters struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// GroupID - The object ID of the group to check.
	GroupID *string `json:"groupId,omitempty"`
	// MemberID - The object ID of the contact, group, user, or service principal to check for membership in the specified group.
	MemberID *string `json:"memberId,omitempty"`
}

CheckGroupMembershipParameters request parameters for IsMemberOf API call.

func (CheckGroupMembershipParameters) MarshalJSON

func (cgmp CheckGroupMembershipParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CheckGroupMembershipParameters.

func (*CheckGroupMembershipParameters) UnmarshalJSON

func (cgmp *CheckGroupMembershipParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CheckGroupMembershipParameters struct.

type CheckGroupMembershipResult

type CheckGroupMembershipResult struct {
	autorest.Response `json:"-"`
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// Value - True if the specified user, group, contact, or service principal has either direct or transitive membership in the specified group; otherwise, false.
	Value *bool `json:"value,omitempty"`
}

CheckGroupMembershipResult server response for IsMemberOf API call

func (CheckGroupMembershipResult) MarshalJSON

func (cgmr CheckGroupMembershipResult) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for CheckGroupMembershipResult.

func (*CheckGroupMembershipResult) UnmarshalJSON

func (cgmr *CheckGroupMembershipResult) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for CheckGroupMembershipResult struct.

type ConsentType

type ConsentType string

ConsentType enumerates the values for consent type.

const (
	// AllPrincipals ...
	AllPrincipals ConsentType = "AllPrincipals"
	// Principal ...
	Principal ConsentType = "Principal"
)

func PossibleConsentTypeValues

func PossibleConsentTypeValues() []ConsentType

PossibleConsentTypeValues returns an array of possible values for the ConsentType const type.

type DeletedApplicationsClient

type DeletedApplicationsClient struct {
	BaseClient
}

DeletedApplicationsClient is the the Graph RBAC Management Client

func NewDeletedApplicationsClient

func NewDeletedApplicationsClient(tenantID string) DeletedApplicationsClient

NewDeletedApplicationsClient creates an instance of the DeletedApplicationsClient client.

func NewDeletedApplicationsClientWithBaseURI

func NewDeletedApplicationsClientWithBaseURI(baseURI string, tenantID string) DeletedApplicationsClient

NewDeletedApplicationsClientWithBaseURI creates an instance of the DeletedApplicationsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (DeletedApplicationsClient) HardDelete

func (client DeletedApplicationsClient) HardDelete(ctx context.Context, applicationObjectID string) (result autorest.Response, err error)

HardDelete hard-delete an application. Parameters: applicationObjectID - application object ID.

func (DeletedApplicationsClient) HardDeletePreparer

func (client DeletedApplicationsClient) HardDeletePreparer(ctx context.Context, applicationObjectID string) (*http.Request, error)

HardDeletePreparer prepares the HardDelete request.

func (DeletedApplicationsClient) HardDeleteResponder

func (client DeletedApplicationsClient) HardDeleteResponder(resp *http.Response) (result autorest.Response, err error)

HardDeleteResponder handles the response to the HardDelete request. The method always closes the http.Response Body.

func (DeletedApplicationsClient) HardDeleteSender

func (client DeletedApplicationsClient) HardDeleteSender(req *http.Request) (*http.Response, error)

HardDeleteSender sends the HardDelete request. The method will close the http.Response Body if it receives an error.

func (DeletedApplicationsClient) List

func (client DeletedApplicationsClient) List(ctx context.Context, filter string) (result ApplicationListResultPage, err error)

List gets a list of deleted applications in the directory. Parameters: filter - the filter to apply to the operation.

func (DeletedApplicationsClient) ListComplete

func (client DeletedApplicationsClient) ListComplete(ctx context.Context, filter string) (result ApplicationListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (DeletedApplicationsClient) ListNext

func (client DeletedApplicationsClient) ListNext(ctx context.Context, nextLink string) (result ApplicationListResult, err error)

ListNext gets a list of deleted applications in the directory. Parameters: nextLink - next link for the list operation.

func (DeletedApplicationsClient) ListNextPreparer

func (client DeletedApplicationsClient) ListNextPreparer(ctx context.Context, nextLink string) (*http.Request, error)

ListNextPreparer prepares the ListNext request.

func (DeletedApplicationsClient) ListNextResponder

func (client DeletedApplicationsClient) ListNextResponder(resp *http.Response) (result ApplicationListResult, err error)

ListNextResponder handles the response to the ListNext request. The method always closes the http.Response Body.

func (DeletedApplicationsClient) ListNextSender

func (client DeletedApplicationsClient) ListNextSender(req *http.Request) (*http.Response, error)

ListNextSender sends the ListNext request. The method will close the http.Response Body if it receives an error.

func (DeletedApplicationsClient) ListPreparer

func (client DeletedApplicationsClient) ListPreparer(ctx context.Context, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (DeletedApplicationsClient) ListResponder

func (client DeletedApplicationsClient) ListResponder(resp *http.Response) (result ApplicationListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (DeletedApplicationsClient) ListSender

func (client DeletedApplicationsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (DeletedApplicationsClient) Restore

func (client DeletedApplicationsClient) Restore(ctx context.Context, objectID string) (result Application, err error)

Restore restores the deleted application in the directory. Parameters: objectID - application object ID.

func (DeletedApplicationsClient) RestorePreparer

func (client DeletedApplicationsClient) RestorePreparer(ctx context.Context, objectID string) (*http.Request, error)

RestorePreparer prepares the Restore request.

func (DeletedApplicationsClient) RestoreResponder

func (client DeletedApplicationsClient) RestoreResponder(resp *http.Response) (result Application, err error)

RestoreResponder handles the response to the Restore request. The method always closes the http.Response Body.

func (DeletedApplicationsClient) RestoreSender

func (client DeletedApplicationsClient) RestoreSender(req *http.Request) (*http.Response, error)

RestoreSender sends the Restore request. The method will close the http.Response Body if it receives an error.

type DirectoryObject

type DirectoryObject struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// ObjectID - READ-ONLY; The object ID.
	ObjectID *string `json:"objectId,omitempty"`
	// DeletionTimestamp - READ-ONLY; The time at which the directory object was deleted.
	DeletionTimestamp *date.Time `json:"deletionTimestamp,omitempty"`
	// ObjectType - Possible values include: 'ObjectTypeDirectoryObject', 'ObjectTypeApplication', 'ObjectTypeGroup', 'ObjectTypeServicePrincipal', 'ObjectTypeUser'
	ObjectType ObjectType `json:"objectType,omitempty"`
}

DirectoryObject represents an Azure Active Directory object.

func (DirectoryObject) AsADGroup

func (do DirectoryObject) AsADGroup() (*ADGroup, bool)

AsADGroup is the BasicDirectoryObject implementation for DirectoryObject.

func (DirectoryObject) AsApplication

func (do DirectoryObject) AsApplication() (*Application, bool)

AsApplication is the BasicDirectoryObject implementation for DirectoryObject.

func (DirectoryObject) AsBasicDirectoryObject

func (do DirectoryObject) AsBasicDirectoryObject() (BasicDirectoryObject, bool)

AsBasicDirectoryObject is the BasicDirectoryObject implementation for DirectoryObject.

func (DirectoryObject) AsDirectoryObject

func (do DirectoryObject) AsDirectoryObject() (*DirectoryObject, bool)

AsDirectoryObject is the BasicDirectoryObject implementation for DirectoryObject.

func (DirectoryObject) AsServicePrincipal

func (do DirectoryObject) AsServicePrincipal() (*ServicePrincipal, bool)

AsServicePrincipal is the BasicDirectoryObject implementation for DirectoryObject.

func (DirectoryObject) AsUser

func (do DirectoryObject) AsUser() (*User, bool)

AsUser is the BasicDirectoryObject implementation for DirectoryObject.

func (DirectoryObject) MarshalJSON

func (do DirectoryObject) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for DirectoryObject.

func (*DirectoryObject) UnmarshalJSON

func (do *DirectoryObject) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DirectoryObject struct.

type DirectoryObjectListResult

type DirectoryObjectListResult struct {
	autorest.Response `json:"-"`
	// Value - A collection of DirectoryObject.
	Value *[]BasicDirectoryObject `json:"value,omitempty"`
	// OdataNextLink - The URL to get the next set of results.
	OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

DirectoryObjectListResult directoryObject list operation result.

func (DirectoryObjectListResult) IsEmpty

func (dolr DirectoryObjectListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

func (*DirectoryObjectListResult) UnmarshalJSON

func (dolr *DirectoryObjectListResult) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for DirectoryObjectListResult struct.

type DirectoryObjectListResultIterator

type DirectoryObjectListResultIterator struct {
	// contains filtered or unexported fields
}

DirectoryObjectListResultIterator provides access to a complete listing of DirectoryObject values.

func NewDirectoryObjectListResultIterator

func NewDirectoryObjectListResultIterator(page DirectoryObjectListResultPage) DirectoryObjectListResultIterator

Creates a new instance of the DirectoryObjectListResultIterator type.

func (*DirectoryObjectListResultIterator) Next

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*DirectoryObjectListResultIterator) NextWithContext

func (iter *DirectoryObjectListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (DirectoryObjectListResultIterator) NotDone

func (iter DirectoryObjectListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (DirectoryObjectListResultIterator) Response

Response returns the raw server response from the last page request.

func (DirectoryObjectListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type DirectoryObjectListResultPage

type DirectoryObjectListResultPage struct {
	// contains filtered or unexported fields
}

DirectoryObjectListResultPage contains a page of BasicDirectoryObject values.

func NewDirectoryObjectListResultPage

Creates a new instance of the DirectoryObjectListResultPage type.

func (*DirectoryObjectListResultPage) Next

func (page *DirectoryObjectListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*DirectoryObjectListResultPage) NextWithContext

func (page *DirectoryObjectListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (DirectoryObjectListResultPage) NotDone

func (page DirectoryObjectListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (DirectoryObjectListResultPage) Response

Response returns the raw server response from the last page request.

func (DirectoryObjectListResultPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type Domain

type Domain struct {
	autorest.Response `json:"-"`
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// AuthenticationType - READ-ONLY; the type of the authentication into the domain.
	AuthenticationType *string `json:"authenticationType,omitempty"`
	// IsDefault - READ-ONLY; if this is the default domain in the tenant.
	IsDefault *bool `json:"isDefault,omitempty"`
	// IsVerified - READ-ONLY; if this domain's ownership is verified.
	IsVerified *bool `json:"isVerified,omitempty"`
	// Name - the domain name.
	Name *string `json:"name,omitempty"`
}

Domain active Directory Domain information.

func (Domain) MarshalJSON

func (d Domain) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for Domain.

func (*Domain) UnmarshalJSON

func (d *Domain) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for Domain struct.

type DomainListResult

type DomainListResult struct {
	autorest.Response `json:"-"`
	// Value - the list of domains.
	Value *[]Domain `json:"value,omitempty"`
}

DomainListResult server response for Get tenant domains API call.

type DomainsClient

type DomainsClient struct {
	BaseClient
}

DomainsClient is the the Graph RBAC Management Client

func NewDomainsClient

func NewDomainsClient(tenantID string) DomainsClient

NewDomainsClient creates an instance of the DomainsClient client.

func NewDomainsClientWithBaseURI

func NewDomainsClientWithBaseURI(baseURI string, tenantID string) DomainsClient

NewDomainsClientWithBaseURI creates an instance of the DomainsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (DomainsClient) Get

func (client DomainsClient) Get(ctx context.Context, domainName string) (result Domain, err error)

Get gets a specific domain in the current tenant. Parameters: domainName - name of the domain.

func (DomainsClient) GetPreparer

func (client DomainsClient) GetPreparer(ctx context.Context, domainName string) (*http.Request, error)

GetPreparer prepares the Get request.

func (DomainsClient) GetResponder

func (client DomainsClient) GetResponder(resp *http.Response) (result Domain, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (DomainsClient) GetSender

func (client DomainsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (DomainsClient) List

func (client DomainsClient) List(ctx context.Context, filter string) (result DomainListResult, err error)

List gets a list of domains for the current tenant. Parameters: filter - the filter to apply to the operation.

func (DomainsClient) ListPreparer

func (client DomainsClient) ListPreparer(ctx context.Context, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (DomainsClient) ListResponder

func (client DomainsClient) ListResponder(resp *http.Response) (result DomainListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (DomainsClient) ListSender

func (client DomainsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type ErrorMessage

type ErrorMessage struct {
	// Message - Error message value.
	Message *string `json:"value,omitempty"`
}

ErrorMessage active Directory error message.

type GetObjectsParameters

type GetObjectsParameters struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// ObjectIds - The requested object IDs.
	ObjectIds *[]string `json:"objectIds,omitempty"`
	// Types - The requested object types.
	Types *[]string `json:"types,omitempty"`
	// IncludeDirectoryObjectReferences - If true, also searches for object IDs in the partner tenant.
	IncludeDirectoryObjectReferences *bool `json:"includeDirectoryObjectReferences,omitempty"`
}

GetObjectsParameters request parameters for the GetObjectsByObjectIds API.

func (GetObjectsParameters) MarshalJSON

func (gop GetObjectsParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GetObjectsParameters.

func (*GetObjectsParameters) UnmarshalJSON

func (gop *GetObjectsParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GetObjectsParameters struct.

type GraphError

type GraphError struct {
	// OdataError - A Graph API error.
	*OdataError `json:"odata.error,omitempty"`
}

GraphError active Directory error information.

func (GraphError) MarshalJSON

func (ge GraphError) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GraphError.

func (*GraphError) UnmarshalJSON

func (ge *GraphError) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GraphError struct.

type GroupAddMemberParameters

type GroupAddMemberParameters struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// URL - 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 *string `json:"url,omitempty"`
}

GroupAddMemberParameters request parameters for adding a member to a group.

func (GroupAddMemberParameters) MarshalJSON

func (gamp GroupAddMemberParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GroupAddMemberParameters.

func (*GroupAddMemberParameters) UnmarshalJSON

func (gamp *GroupAddMemberParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GroupAddMemberParameters struct.

type GroupCreateParameters

type GroupCreateParameters struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// DisplayName - Group display name
	DisplayName *string `json:"displayName,omitempty"`
	// MailEnabled - Whether the group is mail-enabled. Must be false. This is because only pure security groups can be created using the Graph API.
	MailEnabled *bool `json:"mailEnabled,omitempty"`
	// MailNickname - Mail nickname
	MailNickname *string `json:"mailNickname,omitempty"`
	// SecurityEnabled - Whether the group is a security group. Must be true. This is because only pure security groups can be created using the Graph API.
	SecurityEnabled *bool `json:"securityEnabled,omitempty"`
}

GroupCreateParameters request parameters for creating a new group.

func (GroupCreateParameters) MarshalJSON

func (gcp GroupCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GroupCreateParameters.

func (*GroupCreateParameters) UnmarshalJSON

func (gcp *GroupCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GroupCreateParameters struct.

type GroupGetMemberGroupsParameters

type GroupGetMemberGroupsParameters struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// SecurityEnabledOnly - If true, only membership in security-enabled groups should be checked. Otherwise, membership in all groups should be checked.
	SecurityEnabledOnly *bool `json:"securityEnabledOnly,omitempty"`
}

GroupGetMemberGroupsParameters request parameters for GetMemberGroups API call.

func (GroupGetMemberGroupsParameters) MarshalJSON

func (ggmgp GroupGetMemberGroupsParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for GroupGetMemberGroupsParameters.

func (*GroupGetMemberGroupsParameters) UnmarshalJSON

func (ggmgp *GroupGetMemberGroupsParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for GroupGetMemberGroupsParameters struct.

type GroupGetMemberGroupsResult

type GroupGetMemberGroupsResult struct {
	autorest.Response `json:"-"`
	// Value - A collection of group IDs of which the group is a member.
	Value *[]string `json:"value,omitempty"`
}

GroupGetMemberGroupsResult server response for GetMemberGroups API call.

type GroupListResult

type GroupListResult struct {
	autorest.Response `json:"-"`
	// Value - A collection of Active Directory groups.
	Value *[]ADGroup `json:"value,omitempty"`
	// OdataNextLink - The URL to get the next set of results.
	OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

GroupListResult server response for Get tenant groups API call

func (GroupListResult) IsEmpty

func (glr GroupListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type GroupListResultIterator

type GroupListResultIterator struct {
	// contains filtered or unexported fields
}

GroupListResultIterator provides access to a complete listing of ADGroup values.

func NewGroupListResultIterator

func NewGroupListResultIterator(page GroupListResultPage) GroupListResultIterator

Creates a new instance of the GroupListResultIterator type.

func (*GroupListResultIterator) Next

func (iter *GroupListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*GroupListResultIterator) NextWithContext

func (iter *GroupListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (GroupListResultIterator) NotDone

func (iter GroupListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (GroupListResultIterator) Response

func (iter GroupListResultIterator) Response() GroupListResult

Response returns the raw server response from the last page request.

func (GroupListResultIterator) Value

func (iter GroupListResultIterator) Value() ADGroup

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type GroupListResultPage

type GroupListResultPage struct {
	// contains filtered or unexported fields
}

GroupListResultPage contains a page of ADGroup values.

func NewGroupListResultPage

func NewGroupListResultPage(cur GroupListResult, getNextPage func(context.Context, GroupListResult) (GroupListResult, error)) GroupListResultPage

Creates a new instance of the GroupListResultPage type.

func (*GroupListResultPage) Next

func (page *GroupListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*GroupListResultPage) NextWithContext

func (page *GroupListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (GroupListResultPage) NotDone

func (page GroupListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (GroupListResultPage) Response

func (page GroupListResultPage) Response() GroupListResult

Response returns the raw server response from the last page request.

func (GroupListResultPage) Values

func (page GroupListResultPage) Values() []ADGroup

Values returns the slice of values for the current page or nil if there are no values.

type GroupMembershipClaimTypes

type GroupMembershipClaimTypes string

GroupMembershipClaimTypes enumerates the values for group membership claim types.

const (
	// All ...
	All GroupMembershipClaimTypes = "All"
	// None ...
	None GroupMembershipClaimTypes = "None"
	// SecurityGroup ...
	SecurityGroup GroupMembershipClaimTypes = "SecurityGroup"
)

func PossibleGroupMembershipClaimTypesValues

func PossibleGroupMembershipClaimTypesValues() []GroupMembershipClaimTypes

PossibleGroupMembershipClaimTypesValues returns an array of possible values for the GroupMembershipClaimTypes const type.

type GroupsClient

type GroupsClient struct {
	BaseClient
}

GroupsClient is the the Graph RBAC Management Client

func NewGroupsClient

func NewGroupsClient(tenantID string) GroupsClient

NewGroupsClient creates an instance of the GroupsClient client.

func NewGroupsClientWithBaseURI

func NewGroupsClientWithBaseURI(baseURI string, tenantID string) GroupsClient

NewGroupsClientWithBaseURI creates an instance of the GroupsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (GroupsClient) AddMember

func (client GroupsClient) AddMember(ctx context.Context, groupObjectID string, parameters GroupAddMemberParameters) (result autorest.Response, err error)

AddMember add a member to a group. Parameters: groupObjectID - the object ID of the group to which to add the member. parameters - the URL of the member object, such as https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd.

func (GroupsClient) AddMemberPreparer

func (client GroupsClient) AddMemberPreparer(ctx context.Context, groupObjectID string, parameters GroupAddMemberParameters) (*http.Request, error)

AddMemberPreparer prepares the AddMember request.

func (GroupsClient) AddMemberResponder

func (client GroupsClient) AddMemberResponder(resp *http.Response) (result autorest.Response, err error)

AddMemberResponder handles the response to the AddMember request. The method always closes the http.Response Body.

func (GroupsClient) AddMemberSender

func (client GroupsClient) AddMemberSender(req *http.Request) (*http.Response, error)

AddMemberSender sends the AddMember request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) AddOwner

func (client GroupsClient) AddOwner(ctx context.Context, objectID string, parameters AddOwnerParameters) (result autorest.Response, err error)

AddOwner add an owner to a group. Parameters: objectID - the object ID of the application to which to add the owner. parameters - the URL of the owner object, such as https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd.

func (GroupsClient) AddOwnerPreparer

func (client GroupsClient) AddOwnerPreparer(ctx context.Context, objectID string, parameters AddOwnerParameters) (*http.Request, error)

AddOwnerPreparer prepares the AddOwner request.

func (GroupsClient) AddOwnerResponder

func (client GroupsClient) AddOwnerResponder(resp *http.Response) (result autorest.Response, err error)

AddOwnerResponder handles the response to the AddOwner request. The method always closes the http.Response Body.

func (GroupsClient) AddOwnerSender

func (client GroupsClient) AddOwnerSender(req *http.Request) (*http.Response, error)

AddOwnerSender sends the AddOwner request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) Create

func (client GroupsClient) Create(ctx context.Context, parameters GroupCreateParameters) (result ADGroup, err error)

Create create a group in the directory. Parameters: parameters - the parameters for the group to create.

func (GroupsClient) CreatePreparer

func (client GroupsClient) CreatePreparer(ctx context.Context, parameters GroupCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (GroupsClient) CreateResponder

func (client GroupsClient) CreateResponder(resp *http.Response) (result ADGroup, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (GroupsClient) CreateSender

func (client GroupsClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) Delete

func (client GroupsClient) Delete(ctx context.Context, objectID string) (result autorest.Response, err error)

Delete delete a group from the directory. Parameters: objectID - the object ID of the group to delete.

func (GroupsClient) DeletePreparer

func (client GroupsClient) DeletePreparer(ctx context.Context, objectID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (GroupsClient) DeleteResponder

func (client GroupsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (GroupsClient) DeleteSender

func (client GroupsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) Get

func (client GroupsClient) Get(ctx context.Context, objectID string) (result ADGroup, err error)

Get gets group information from the directory. Parameters: objectID - the object ID of the user for which to get group information.

func (GroupsClient) GetGroupMembers

func (client GroupsClient) GetGroupMembers(ctx context.Context, objectID string) (result DirectoryObjectListResultPage, err error)

GetGroupMembers gets the members of a group. Parameters: objectID - the object ID of the group whose members should be retrieved.

func (GroupsClient) GetGroupMembersComplete

func (client GroupsClient) GetGroupMembersComplete(ctx context.Context, objectID string) (result DirectoryObjectListResultIterator, err error)

GetGroupMembersComplete enumerates all values, automatically crossing page boundaries as required.

func (GroupsClient) GetGroupMembersNext

func (client GroupsClient) GetGroupMembersNext(ctx context.Context, nextLink string) (result DirectoryObjectListResult, err error)

GetGroupMembersNext gets the members of a group. Parameters: nextLink - next link for the list operation.

func (GroupsClient) GetGroupMembersNextPreparer

func (client GroupsClient) GetGroupMembersNextPreparer(ctx context.Context, nextLink string) (*http.Request, error)

GetGroupMembersNextPreparer prepares the GetGroupMembersNext request.

func (GroupsClient) GetGroupMembersNextResponder

func (client GroupsClient) GetGroupMembersNextResponder(resp *http.Response) (result DirectoryObjectListResult, err error)

GetGroupMembersNextResponder handles the response to the GetGroupMembersNext request. The method always closes the http.Response Body.

func (GroupsClient) GetGroupMembersNextSender

func (client GroupsClient) GetGroupMembersNextSender(req *http.Request) (*http.Response, error)

GetGroupMembersNextSender sends the GetGroupMembersNext request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) GetGroupMembersPreparer

func (client GroupsClient) GetGroupMembersPreparer(ctx context.Context, objectID string) (*http.Request, error)

GetGroupMembersPreparer prepares the GetGroupMembers request.

func (GroupsClient) GetGroupMembersResponder

func (client GroupsClient) GetGroupMembersResponder(resp *http.Response) (result DirectoryObjectListResult, err error)

GetGroupMembersResponder handles the response to the GetGroupMembers request. The method always closes the http.Response Body.

func (GroupsClient) GetGroupMembersSender

func (client GroupsClient) GetGroupMembersSender(req *http.Request) (*http.Response, error)

GetGroupMembersSender sends the GetGroupMembers request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) GetMemberGroups

func (client GroupsClient) GetMemberGroups(ctx context.Context, objectID string, parameters GroupGetMemberGroupsParameters) (result GroupGetMemberGroupsResult, err error)

GetMemberGroups gets a collection of object IDs of groups of which the specified group is a member. Parameters: objectID - the object ID of the group for which to get group membership. parameters - group filtering parameters.

func (GroupsClient) GetMemberGroupsPreparer

func (client GroupsClient) GetMemberGroupsPreparer(ctx context.Context, objectID string, parameters GroupGetMemberGroupsParameters) (*http.Request, error)

GetMemberGroupsPreparer prepares the GetMemberGroups request.

func (GroupsClient) GetMemberGroupsResponder

func (client GroupsClient) GetMemberGroupsResponder(resp *http.Response) (result GroupGetMemberGroupsResult, err error)

GetMemberGroupsResponder handles the response to the GetMemberGroups request. The method always closes the http.Response Body.

func (GroupsClient) GetMemberGroupsSender

func (client GroupsClient) GetMemberGroupsSender(req *http.Request) (*http.Response, error)

GetMemberGroupsSender sends the GetMemberGroups request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) GetPreparer

func (client GroupsClient) GetPreparer(ctx context.Context, objectID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (GroupsClient) GetResponder

func (client GroupsClient) GetResponder(resp *http.Response) (result ADGroup, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (GroupsClient) GetSender

func (client GroupsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) IsMemberOf

func (client GroupsClient) IsMemberOf(ctx context.Context, parameters CheckGroupMembershipParameters) (result CheckGroupMembershipResult, err error)

IsMemberOf checks whether the specified user, group, contact, or service principal is a direct or transitive member of the specified group. Parameters: parameters - the check group membership parameters.

func (GroupsClient) IsMemberOfPreparer

func (client GroupsClient) IsMemberOfPreparer(ctx context.Context, parameters CheckGroupMembershipParameters) (*http.Request, error)

IsMemberOfPreparer prepares the IsMemberOf request.

func (GroupsClient) IsMemberOfResponder

func (client GroupsClient) IsMemberOfResponder(resp *http.Response) (result CheckGroupMembershipResult, err error)

IsMemberOfResponder handles the response to the IsMemberOf request. The method always closes the http.Response Body.

func (GroupsClient) IsMemberOfSender

func (client GroupsClient) IsMemberOfSender(req *http.Request) (*http.Response, error)

IsMemberOfSender sends the IsMemberOf request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) List

func (client GroupsClient) List(ctx context.Context, filter string) (result GroupListResultPage, err error)

List gets list of groups for the current tenant. Parameters: filter - the filter to apply to the operation.

func (GroupsClient) ListComplete

func (client GroupsClient) ListComplete(ctx context.Context, filter string) (result GroupListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (GroupsClient) ListNext

func (client GroupsClient) ListNext(ctx context.Context, nextLink string) (result GroupListResult, err error)

ListNext gets a list of groups for the current tenant. Parameters: nextLink - next link for the list operation.

func (GroupsClient) ListNextPreparer

func (client GroupsClient) ListNextPreparer(ctx context.Context, nextLink string) (*http.Request, error)

ListNextPreparer prepares the ListNext request.

func (GroupsClient) ListNextResponder

func (client GroupsClient) ListNextResponder(resp *http.Response) (result GroupListResult, err error)

ListNextResponder handles the response to the ListNext request. The method always closes the http.Response Body.

func (GroupsClient) ListNextSender

func (client GroupsClient) ListNextSender(req *http.Request) (*http.Response, error)

ListNextSender sends the ListNext request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) ListOwners

func (client GroupsClient) ListOwners(ctx context.Context, objectID string) (result DirectoryObjectListResultPage, err error)

ListOwners the owners are a set of non-admin users who are allowed to modify this object. Parameters: objectID - the object ID of the group for which to get owners.

func (GroupsClient) ListOwnersComplete

func (client GroupsClient) ListOwnersComplete(ctx context.Context, objectID string) (result DirectoryObjectListResultIterator, err error)

ListOwnersComplete enumerates all values, automatically crossing page boundaries as required.

func (GroupsClient) ListOwnersPreparer

func (client GroupsClient) ListOwnersPreparer(ctx context.Context, objectID string) (*http.Request, error)

ListOwnersPreparer prepares the ListOwners request.

func (GroupsClient) ListOwnersResponder

func (client GroupsClient) ListOwnersResponder(resp *http.Response) (result DirectoryObjectListResult, err error)

ListOwnersResponder handles the response to the ListOwners request. The method always closes the http.Response Body.

func (GroupsClient) ListOwnersSender

func (client GroupsClient) ListOwnersSender(req *http.Request) (*http.Response, error)

ListOwnersSender sends the ListOwners request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) ListPreparer

func (client GroupsClient) ListPreparer(ctx context.Context, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (GroupsClient) ListResponder

func (client GroupsClient) ListResponder(resp *http.Response) (result GroupListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (GroupsClient) ListSender

func (client GroupsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) RemoveMember

func (client GroupsClient) RemoveMember(ctx context.Context, groupObjectID string, memberObjectID string) (result autorest.Response, err error)

RemoveMember remove a member from a group. Parameters: groupObjectID - the object ID of the group from which to remove the member. memberObjectID - member object id

func (GroupsClient) RemoveMemberPreparer

func (client GroupsClient) RemoveMemberPreparer(ctx context.Context, groupObjectID string, memberObjectID string) (*http.Request, error)

RemoveMemberPreparer prepares the RemoveMember request.

func (GroupsClient) RemoveMemberResponder

func (client GroupsClient) RemoveMemberResponder(resp *http.Response) (result autorest.Response, err error)

RemoveMemberResponder handles the response to the RemoveMember request. The method always closes the http.Response Body.

func (GroupsClient) RemoveMemberSender

func (client GroupsClient) RemoveMemberSender(req *http.Request) (*http.Response, error)

RemoveMemberSender sends the RemoveMember request. The method will close the http.Response Body if it receives an error.

func (GroupsClient) RemoveOwner

func (client GroupsClient) RemoveOwner(ctx context.Context, objectID string, ownerObjectID string) (result autorest.Response, err error)

RemoveOwner remove a member from owners. Parameters: objectID - the object ID of the group from which to remove the owner. ownerObjectID - owner object id

func (GroupsClient) RemoveOwnerPreparer

func (client GroupsClient) RemoveOwnerPreparer(ctx context.Context, objectID string, ownerObjectID string) (*http.Request, error)

RemoveOwnerPreparer prepares the RemoveOwner request.

func (GroupsClient) RemoveOwnerResponder

func (client GroupsClient) RemoveOwnerResponder(resp *http.Response) (result autorest.Response, err error)

RemoveOwnerResponder handles the response to the RemoveOwner request. The method always closes the http.Response Body.

func (GroupsClient) RemoveOwnerSender

func (client GroupsClient) RemoveOwnerSender(req *http.Request) (*http.Response, error)

RemoveOwnerSender sends the RemoveOwner request. The method will close the http.Response Body if it receives an error.

type InformationalURL

type InformationalURL struct {
	// TermsOfService - The terms of service URI
	TermsOfService *string `json:"termsOfService,omitempty"`
	// Marketing - The marketing URI
	Marketing *string `json:"marketing,omitempty"`
	// Privacy - The privacy policy URI
	Privacy *string `json:"privacy,omitempty"`
	// Support - The support URI
	Support *string `json:"support,omitempty"`
}

InformationalURL 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.

type KeyCredential

type KeyCredential struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// StartDate - Start date.
	StartDate *date.Time `json:"startDate,omitempty"`
	// EndDate - End date.
	EndDate *date.Time `json:"endDate,omitempty"`
	// Value - Key value.
	Value *string `json:"value,omitempty"`
	// KeyID - Key ID.
	KeyID *string `json:"keyId,omitempty"`
	// Usage - Usage. Acceptable values are 'Verify' and 'Sign'.
	Usage *string `json:"usage,omitempty"`
	// Type - Type. Acceptable values are 'AsymmetricX509Cert' and 'Symmetric'.
	Type *string `json:"type,omitempty"`
	// CustomKeyIdentifier - Custom Key Identifier
	CustomKeyIdentifier *string `json:"customKeyIdentifier,omitempty"`
}

KeyCredential active Directory Key Credential information.

func (KeyCredential) MarshalJSON

func (kc KeyCredential) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for KeyCredential.

func (*KeyCredential) UnmarshalJSON

func (kc *KeyCredential) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for KeyCredential struct.

type KeyCredentialListResult

type KeyCredentialListResult struct {
	autorest.Response `json:"-"`
	// Value - A collection of KeyCredentials.
	Value *[]KeyCredential `json:"value,omitempty"`
}

KeyCredentialListResult keyCredential list operation result.

type KeyCredentialsUpdateParameters

type KeyCredentialsUpdateParameters struct {
	// Value - A collection of KeyCredentials.
	Value *[]KeyCredential `json:"value,omitempty"`
}

KeyCredentialsUpdateParameters request parameters for a KeyCredentials update operation

type OAuth2Permission

type OAuth2Permission struct {
	// AdminConsentDescription - Permission help text that appears in the admin consent and app assignment experiences.
	AdminConsentDescription *string `json:"adminConsentDescription,omitempty"`
	// AdminConsentDisplayName - Display name for the permission that appears in the admin consent and app assignment experiences.
	AdminConsentDisplayName *string `json:"adminConsentDisplayName,omitempty"`
	// ID - Unique scope permission identifier inside the oauth2Permissions collection.
	ID *string `json:"id,omitempty"`
	// IsEnabled - 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.
	IsEnabled *bool `json:"isEnabled,omitempty"`
	// Type - 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".
	Type *string `json:"type,omitempty"`
	// UserConsentDescription - Permission help text that appears in the end user consent experience.
	UserConsentDescription *string `json:"userConsentDescription,omitempty"`
	// UserConsentDisplayName - Display name for the permission that appears in the end user consent experience.
	UserConsentDisplayName *string `json:"userConsentDisplayName,omitempty"`
	// Value - The value of the scope claim that the resource application should expect in the OAuth 2.0 access token.
	Value *string `json:"value,omitempty"`
}

OAuth2Permission 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.

type OAuth2PermissionGrant

type OAuth2PermissionGrant struct {
	autorest.Response `json:"-"`
	// OdataType - Microsoft.DirectoryServices.OAuth2PermissionGrant
	OdataType *string `json:"odata.type,omitempty"`
	// ClientID - The id of the resource's service principal granted consent to impersonate the user when accessing the resource (represented by the resourceId property).
	ClientID *string `json:"clientId,omitempty"`
	// ObjectID - The id of the permission grant
	ObjectID *string `json:"objectId,omitempty"`
	// ConsentType - Indicates if consent was provided by the administrator (on behalf of the organization) or by an individual. Possible values include: 'AllPrincipals', 'Principal'
	ConsentType ConsentType `json:"consentType,omitempty"`
	// PrincipalID - When consent type is Principal, this property specifies the id of the user that granted consent and applies only for that user.
	PrincipalID *string `json:"principalId,omitempty"`
	// ResourceID - Object Id of the resource you want to grant
	ResourceID *string `json:"resourceId,omitempty"`
	// Scope - Specifies the value of the scope claim that the resource application should expect in the OAuth 2.0 access token. For example, User.Read
	Scope *string `json:"scope,omitempty"`
	// StartTime - Start time for TTL
	StartTime *string `json:"startTime,omitempty"`
	// ExpiryTime - Expiry time for TTL
	ExpiryTime *string `json:"expiryTime,omitempty"`
}

OAuth2PermissionGrant ...

type OAuth2PermissionGrantClient

type OAuth2PermissionGrantClient struct {
	BaseClient
}

OAuth2PermissionGrantClient is the the Graph RBAC Management Client

func NewOAuth2PermissionGrantClient

func NewOAuth2PermissionGrantClient(tenantID string) OAuth2PermissionGrantClient

NewOAuth2PermissionGrantClient creates an instance of the OAuth2PermissionGrantClient client.

func NewOAuth2PermissionGrantClientWithBaseURI

func NewOAuth2PermissionGrantClientWithBaseURI(baseURI string, tenantID string) OAuth2PermissionGrantClient

NewOAuth2PermissionGrantClientWithBaseURI creates an instance of the OAuth2PermissionGrantClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (OAuth2PermissionGrantClient) Create

Create grants OAuth2 permissions for the relevant resource Ids of an app. Parameters: body - the relevant app Service Principal Object Id and the Service Principal Object Id you want to grant.

func (OAuth2PermissionGrantClient) CreatePreparer

func (client OAuth2PermissionGrantClient) CreatePreparer(ctx context.Context, body *OAuth2PermissionGrant) (*http.Request, error)

CreatePreparer prepares the Create request.

func (OAuth2PermissionGrantClient) CreateResponder

func (client OAuth2PermissionGrantClient) CreateResponder(resp *http.Response) (result OAuth2PermissionGrant, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (OAuth2PermissionGrantClient) CreateSender

func (client OAuth2PermissionGrantClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (OAuth2PermissionGrantClient) Delete

func (client OAuth2PermissionGrantClient) Delete(ctx context.Context, objectID string) (result autorest.Response, err error)

Delete delete a OAuth2 permission grant for the relevant resource Ids of an app. Parameters: objectID - the object ID of a permission grant.

func (OAuth2PermissionGrantClient) DeletePreparer

func (client OAuth2PermissionGrantClient) DeletePreparer(ctx context.Context, objectID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (OAuth2PermissionGrantClient) DeleteResponder

func (client OAuth2PermissionGrantClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (OAuth2PermissionGrantClient) DeleteSender

func (client OAuth2PermissionGrantClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (OAuth2PermissionGrantClient) List

List queries OAuth2 permissions grants for the relevant SP ObjectId of an app. Parameters: filter - this is the Service Principal ObjectId associated with the app

func (OAuth2PermissionGrantClient) ListComplete

func (client OAuth2PermissionGrantClient) ListComplete(ctx context.Context, filter string) (result OAuth2PermissionGrantListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (OAuth2PermissionGrantClient) ListNext

func (client OAuth2PermissionGrantClient) ListNext(ctx context.Context, nextLink string) (result OAuth2PermissionGrantListResult, err error)

ListNext gets the next page of OAuth2 permission grants Parameters: nextLink - next link for the list operation.

func (OAuth2PermissionGrantClient) ListNextPreparer

func (client OAuth2PermissionGrantClient) ListNextPreparer(ctx context.Context, nextLink string) (*http.Request, error)

ListNextPreparer prepares the ListNext request.

func (OAuth2PermissionGrantClient) ListNextResponder

func (client OAuth2PermissionGrantClient) ListNextResponder(resp *http.Response) (result OAuth2PermissionGrantListResult, err error)

ListNextResponder handles the response to the ListNext request. The method always closes the http.Response Body.

func (OAuth2PermissionGrantClient) ListNextSender

func (client OAuth2PermissionGrantClient) ListNextSender(req *http.Request) (*http.Response, error)

ListNextSender sends the ListNext request. The method will close the http.Response Body if it receives an error.

func (OAuth2PermissionGrantClient) ListPreparer

func (client OAuth2PermissionGrantClient) ListPreparer(ctx context.Context, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (OAuth2PermissionGrantClient) ListResponder

func (client OAuth2PermissionGrantClient) ListResponder(resp *http.Response) (result OAuth2PermissionGrantListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (OAuth2PermissionGrantClient) ListSender

func (client OAuth2PermissionGrantClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

type OAuth2PermissionGrantListResult

type OAuth2PermissionGrantListResult struct {
	autorest.Response `json:"-"`
	// Value - the list of oauth2 permissions grants
	Value *[]OAuth2PermissionGrant `json:"value,omitempty"`
	// OdataNextLink - the URL to get the next set of results.
	OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

OAuth2PermissionGrantListResult server response for get oauth2 permissions grants

func (OAuth2PermissionGrantListResult) IsEmpty

func (oa2pglr OAuth2PermissionGrantListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type OAuth2PermissionGrantListResultIterator

type OAuth2PermissionGrantListResultIterator struct {
	// contains filtered or unexported fields
}

OAuth2PermissionGrantListResultIterator provides access to a complete listing of OAuth2PermissionGrant values.

func NewOAuth2PermissionGrantListResultIterator

func NewOAuth2PermissionGrantListResultIterator(page OAuth2PermissionGrantListResultPage) OAuth2PermissionGrantListResultIterator

Creates a new instance of the OAuth2PermissionGrantListResultIterator type.

func (*OAuth2PermissionGrantListResultIterator) Next

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OAuth2PermissionGrantListResultIterator) NextWithContext

func (iter *OAuth2PermissionGrantListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (OAuth2PermissionGrantListResultIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (OAuth2PermissionGrantListResultIterator) Response

Response returns the raw server response from the last page request.

func (OAuth2PermissionGrantListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type OAuth2PermissionGrantListResultPage

type OAuth2PermissionGrantListResultPage struct {
	// contains filtered or unexported fields
}

OAuth2PermissionGrantListResultPage contains a page of OAuth2PermissionGrant values.

func NewOAuth2PermissionGrantListResultPage

Creates a new instance of the OAuth2PermissionGrantListResultPage type.

func (*OAuth2PermissionGrantListResultPage) Next

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*OAuth2PermissionGrantListResultPage) NextWithContext

func (page *OAuth2PermissionGrantListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (OAuth2PermissionGrantListResultPage) NotDone

NotDone returns true if the page enumeration should be started or is not yet complete.

func (OAuth2PermissionGrantListResultPage) Response

Response returns the raw server response from the last page request.

func (OAuth2PermissionGrantListResultPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type ObjectType

type ObjectType string

ObjectType enumerates the values for object type.

const (
	// ObjectTypeApplication ...
	ObjectTypeApplication ObjectType = "Application"
	// ObjectTypeDirectoryObject ...
	ObjectTypeDirectoryObject ObjectType = "DirectoryObject"
	// ObjectTypeGroup ...
	ObjectTypeGroup ObjectType = "Group"
	// ObjectTypeServicePrincipal ...
	ObjectTypeServicePrincipal ObjectType = "ServicePrincipal"
	// ObjectTypeUser ...
	ObjectTypeUser ObjectType = "User"
)

func PossibleObjectTypeValues

func PossibleObjectTypeValues() []ObjectType

PossibleObjectTypeValues returns an array of possible values for the ObjectType const type.

type ObjectsClient

type ObjectsClient struct {
	BaseClient
}

ObjectsClient is the the Graph RBAC Management Client

func NewObjectsClient

func NewObjectsClient(tenantID string) ObjectsClient

NewObjectsClient creates an instance of the ObjectsClient client.

func NewObjectsClientWithBaseURI

func NewObjectsClientWithBaseURI(baseURI string, tenantID string) ObjectsClient

NewObjectsClientWithBaseURI creates an instance of the ObjectsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ObjectsClient) GetObjectsByObjectIds

func (client ObjectsClient) GetObjectsByObjectIds(ctx context.Context, parameters GetObjectsParameters) (result DirectoryObjectListResultPage, err error)

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. Parameters: parameters - objects filtering parameters.

func (ObjectsClient) GetObjectsByObjectIdsComplete

func (client ObjectsClient) GetObjectsByObjectIdsComplete(ctx context.Context, parameters GetObjectsParameters) (result DirectoryObjectListResultIterator, err error)

GetObjectsByObjectIdsComplete enumerates all values, automatically crossing page boundaries as required.

func (ObjectsClient) GetObjectsByObjectIdsNext

func (client ObjectsClient) GetObjectsByObjectIdsNext(ctx context.Context, nextLink string) (result DirectoryObjectListResult, err error)

GetObjectsByObjectIdsNext gets AD group membership for the specified AD object IDs. Parameters: nextLink - next link for the list operation.

func (ObjectsClient) GetObjectsByObjectIdsNextPreparer

func (client ObjectsClient) GetObjectsByObjectIdsNextPreparer(ctx context.Context, nextLink string) (*http.Request, error)

GetObjectsByObjectIdsNextPreparer prepares the GetObjectsByObjectIdsNext request.

func (ObjectsClient) GetObjectsByObjectIdsNextResponder

func (client ObjectsClient) GetObjectsByObjectIdsNextResponder(resp *http.Response) (result DirectoryObjectListResult, err error)

GetObjectsByObjectIdsNextResponder handles the response to the GetObjectsByObjectIdsNext request. The method always closes the http.Response Body.

func (ObjectsClient) GetObjectsByObjectIdsNextSender

func (client ObjectsClient) GetObjectsByObjectIdsNextSender(req *http.Request) (*http.Response, error)

GetObjectsByObjectIdsNextSender sends the GetObjectsByObjectIdsNext request. The method will close the http.Response Body if it receives an error.

func (ObjectsClient) GetObjectsByObjectIdsPreparer

func (client ObjectsClient) GetObjectsByObjectIdsPreparer(ctx context.Context, parameters GetObjectsParameters) (*http.Request, error)

GetObjectsByObjectIdsPreparer prepares the GetObjectsByObjectIds request.

func (ObjectsClient) GetObjectsByObjectIdsResponder

func (client ObjectsClient) GetObjectsByObjectIdsResponder(resp *http.Response) (result DirectoryObjectListResult, err error)

GetObjectsByObjectIdsResponder handles the response to the GetObjectsByObjectIds request. The method always closes the http.Response Body.

func (ObjectsClient) GetObjectsByObjectIdsSender

func (client ObjectsClient) GetObjectsByObjectIdsSender(req *http.Request) (*http.Response, error)

GetObjectsByObjectIdsSender sends the GetObjectsByObjectIds request. The method will close the http.Response Body if it receives an error.

type OdataError

type OdataError struct {
	// Code - Error code.
	Code *string `json:"code,omitempty"`
	// ErrorMessage - Error Message.
	*ErrorMessage `json:"message,omitempty"`
}

OdataError active Directory OData error information.

func (OdataError) MarshalJSON

func (oe OdataError) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for OdataError.

func (*OdataError) UnmarshalJSON

func (oe *OdataError) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for OdataError struct.

type OptionalClaim

type OptionalClaim struct {
	// Name - Claim name.
	Name *string `json:"name,omitempty"`
	// Source - Claim source.
	Source *string `json:"source,omitempty"`
	// Essential - Is this a required claim.
	Essential            *bool       `json:"essential,omitempty"`
	AdditionalProperties interface{} `json:"additionalProperties,omitempty"`
}

OptionalClaim specifying the claims to be included in a token.

type OptionalClaims

type OptionalClaims struct {
	// IDToken - Optional claims requested to be included in the id token.
	IDToken *[]OptionalClaim `json:"idToken,omitempty"`
	// AccessToken - Optional claims requested to be included in the access token.
	AccessToken *[]OptionalClaim `json:"accessToken,omitempty"`
	// SamlToken - Optional claims requested to be included in the saml token.
	SamlToken *[]OptionalClaim `json:"samlToken,omitempty"`
}

OptionalClaims specifying the claims to be included in the token.

type PasswordCredential

type PasswordCredential struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// StartDate - Start date.
	StartDate *date.Time `json:"startDate,omitempty"`
	// EndDate - End date.
	EndDate *date.Time `json:"endDate,omitempty"`
	// KeyID - Key ID.
	KeyID *string `json:"keyId,omitempty"`
	// Value - Key value.
	Value *string `json:"value,omitempty"`
	// CustomKeyIdentifier - Custom Key Identifier
	CustomKeyIdentifier *[]byte `json:"customKeyIdentifier,omitempty"`
}

PasswordCredential active Directory Password Credential information.

func (PasswordCredential) MarshalJSON

func (pc PasswordCredential) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PasswordCredential.

func (*PasswordCredential) UnmarshalJSON

func (pc *PasswordCredential) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PasswordCredential struct.

type PasswordCredentialListResult

type PasswordCredentialListResult struct {
	autorest.Response `json:"-"`
	// Value - A collection of PasswordCredentials.
	Value *[]PasswordCredential `json:"value,omitempty"`
}

PasswordCredentialListResult passwordCredential list operation result.

type PasswordCredentialsUpdateParameters

type PasswordCredentialsUpdateParameters struct {
	// Value - A collection of PasswordCredentials.
	Value *[]PasswordCredential `json:"value,omitempty"`
}

PasswordCredentialsUpdateParameters request parameters for a PasswordCredentials update operation.

type PasswordProfile

type PasswordProfile struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// Password - Password
	Password *string `json:"password,omitempty"`
	// ForceChangePasswordNextLogin - Whether to force a password change on next login.
	ForceChangePasswordNextLogin *bool `json:"forceChangePasswordNextLogin,omitempty"`
}

PasswordProfile the password profile associated with a user.

func (PasswordProfile) MarshalJSON

func (pp PasswordProfile) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for PasswordProfile.

func (*PasswordProfile) UnmarshalJSON

func (pp *PasswordProfile) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for PasswordProfile struct.

type PreAuthorizedApplication

type PreAuthorizedApplication struct {
	// AppID - Represents the application id.
	AppID *string `json:"appId,omitempty"`
	// Permissions - Collection of required app permissions/entitlements from the resource application.
	Permissions *[]PreAuthorizedApplicationPermission `json:"permissions,omitempty"`
	// Extensions - Collection of extensions from the resource application.
	Extensions *[]PreAuthorizedApplicationExtension `json:"extensions,omitempty"`
}

PreAuthorizedApplication contains information about pre authorized client application.

type PreAuthorizedApplicationExtension

type PreAuthorizedApplicationExtension struct {
	// Conditions - The extension's conditions.
	Conditions *[]string `json:"conditions,omitempty"`
}

PreAuthorizedApplicationExtension representation of an app PreAuthorizedApplicationExtension required by a pre authorized client app.

type PreAuthorizedApplicationPermission

type PreAuthorizedApplicationPermission struct {
	// DirectAccessGrant - Indicates whether the permission set is DirectAccess or impersonation.
	DirectAccessGrant *bool `json:"directAccessGrant,omitempty"`
	// AccessGrants - The list of permissions.
	AccessGrants *[]string `json:"accessGrants,omitempty"`
}

PreAuthorizedApplicationPermission contains information about the pre-authorized permissions.

type RequiredResourceAccess

type RequiredResourceAccess struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// ResourceAccess - The list of OAuth2.0 permission scopes and app roles that the application requires from the specified resource.
	ResourceAccess *[]ResourceAccess `json:"resourceAccess,omitempty"`
	// ResourceAppID - 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.
	ResourceAppID *string `json:"resourceAppId,omitempty"`
}

RequiredResourceAccess 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.

func (RequiredResourceAccess) MarshalJSON

func (rra RequiredResourceAccess) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for RequiredResourceAccess.

func (*RequiredResourceAccess) UnmarshalJSON

func (rra *RequiredResourceAccess) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for RequiredResourceAccess struct.

type ResourceAccess

type ResourceAccess struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// ID - The unique identifier for one of the OAuth2Permission or AppRole instances that the resource application exposes.
	ID *string `json:"id,omitempty"`
	// Type - Specifies whether the id property references an OAuth2Permission or an AppRole. Possible values are "scope" or "role".
	Type *string `json:"type,omitempty"`
}

ResourceAccess 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.

func (ResourceAccess) MarshalJSON

func (ra ResourceAccess) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ResourceAccess.

func (*ResourceAccess) UnmarshalJSON

func (ra *ResourceAccess) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ResourceAccess struct.

type ServicePrincipal

type ServicePrincipal struct {
	autorest.Response `json:"-"`
	// AccountEnabled - whether or not the service principal account is enabled
	AccountEnabled *bool `json:"accountEnabled,omitempty"`
	// AlternativeNames - alternative names
	AlternativeNames *[]string `json:"alternativeNames,omitempty"`
	// AppDisplayName - READ-ONLY; The display name exposed by the associated application.
	AppDisplayName *string `json:"appDisplayName,omitempty"`
	// AppID - The application ID.
	AppID *string `json:"appId,omitempty"`
	// AppOwnerTenantID - READ-ONLY
	AppOwnerTenantID *string `json:"appOwnerTenantId,omitempty"`
	// AppRoleAssignmentRequired - Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
	AppRoleAssignmentRequired *bool `json:"appRoleAssignmentRequired,omitempty"`
	// AppRoles - The collection of application roles that an application may declare. These roles can be assigned to users, groups or service principals.
	AppRoles *[]AppRole `json:"appRoles,omitempty"`
	// DisplayName - The display name of the service principal.
	DisplayName *string `json:"displayName,omitempty"`
	// ErrorURL - A URL provided by the author of the associated application to report errors when using the application.
	ErrorURL *string `json:"errorUrl,omitempty"`
	// Homepage - The URL to the homepage of the associated application.
	Homepage *string `json:"homepage,omitempty"`
	// KeyCredentials - The collection of key credentials associated with the service principal.
	KeyCredentials *[]KeyCredential `json:"keyCredentials,omitempty"`
	// LogoutURL - A URL provided by the author of the associated application to logout
	LogoutURL *string `json:"logoutUrl,omitempty"`
	// Oauth2Permissions - READ-ONLY; The OAuth 2.0 permissions exposed by the associated application.
	Oauth2Permissions *[]OAuth2Permission `json:"oauth2Permissions,omitempty"`
	// PasswordCredentials - The collection of password credentials associated with the service principal.
	PasswordCredentials *[]PasswordCredential `json:"passwordCredentials,omitempty"`
	// PreferredTokenSigningKeyThumbprint - The thumbprint of preferred certificate to sign the token
	PreferredTokenSigningKeyThumbprint *string `json:"preferredTokenSigningKeyThumbprint,omitempty"`
	// PublisherName - The publisher's name of the associated application
	PublisherName *string `json:"publisherName,omitempty"`
	// ReplyUrls - 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.
	ReplyUrls *[]string `json:"replyUrls,omitempty"`
	// SamlMetadataURL - The URL to the SAML metadata of the associated application
	SamlMetadataURL *string `json:"samlMetadataUrl,omitempty"`
	// ServicePrincipalNames - A collection of service principal names.
	ServicePrincipalNames *[]string `json:"servicePrincipalNames,omitempty"`
	// ServicePrincipalType - the type of the service principal
	ServicePrincipalType *string `json:"servicePrincipalType,omitempty"`
	// Tags - Optional list of tags that you can apply to your service principals. Not nullable.
	Tags *[]string `json:"tags,omitempty"`
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// ObjectID - READ-ONLY; The object ID.
	ObjectID *string `json:"objectId,omitempty"`
	// DeletionTimestamp - READ-ONLY; The time at which the directory object was deleted.
	DeletionTimestamp *date.Time `json:"deletionTimestamp,omitempty"`
	// ObjectType - Possible values include: 'ObjectTypeDirectoryObject', 'ObjectTypeApplication', 'ObjectTypeGroup', 'ObjectTypeServicePrincipal', 'ObjectTypeUser'
	ObjectType ObjectType `json:"objectType,omitempty"`
}

ServicePrincipal active Directory service principal information.

func (ServicePrincipal) AsADGroup

func (sp ServicePrincipal) AsADGroup() (*ADGroup, bool)

AsADGroup is the BasicDirectoryObject implementation for ServicePrincipal.

func (ServicePrincipal) AsApplication

func (sp ServicePrincipal) AsApplication() (*Application, bool)

AsApplication is the BasicDirectoryObject implementation for ServicePrincipal.

func (ServicePrincipal) AsBasicDirectoryObject

func (sp ServicePrincipal) AsBasicDirectoryObject() (BasicDirectoryObject, bool)

AsBasicDirectoryObject is the BasicDirectoryObject implementation for ServicePrincipal.

func (ServicePrincipal) AsDirectoryObject

func (sp ServicePrincipal) AsDirectoryObject() (*DirectoryObject, bool)

AsDirectoryObject is the BasicDirectoryObject implementation for ServicePrincipal.

func (ServicePrincipal) AsServicePrincipal

func (sp ServicePrincipal) AsServicePrincipal() (*ServicePrincipal, bool)

AsServicePrincipal is the BasicDirectoryObject implementation for ServicePrincipal.

func (ServicePrincipal) AsUser

func (sp ServicePrincipal) AsUser() (*User, bool)

AsUser is the BasicDirectoryObject implementation for ServicePrincipal.

func (ServicePrincipal) MarshalJSON

func (sp ServicePrincipal) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for ServicePrincipal.

func (*ServicePrincipal) UnmarshalJSON

func (sp *ServicePrincipal) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for ServicePrincipal struct.

type ServicePrincipalBase

type ServicePrincipalBase struct {
	// AccountEnabled - whether or not the service principal account is enabled
	AccountEnabled *bool `json:"accountEnabled,omitempty"`
	// AppRoleAssignmentRequired - Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
	AppRoleAssignmentRequired *bool `json:"appRoleAssignmentRequired,omitempty"`
	// KeyCredentials - The collection of key credentials associated with the service principal.
	KeyCredentials *[]KeyCredential `json:"keyCredentials,omitempty"`
	// PasswordCredentials - The collection of password credentials associated with the service principal.
	PasswordCredentials *[]PasswordCredential `json:"passwordCredentials,omitempty"`
	// ServicePrincipalType - the type of the service principal
	ServicePrincipalType *string `json:"servicePrincipalType,omitempty"`
	// Tags - Optional list of tags that you can apply to your service principals. Not nullable.
	Tags *[]string `json:"tags,omitempty"`
}

ServicePrincipalBase active Directory service principal common properties shared among GET, POST and PATCH

type ServicePrincipalCreateParameters

type ServicePrincipalCreateParameters struct {
	// AppID - The application ID.
	AppID *string `json:"appId,omitempty"`
	// AccountEnabled - whether or not the service principal account is enabled
	AccountEnabled *bool `json:"accountEnabled,omitempty"`
	// AppRoleAssignmentRequired - Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
	AppRoleAssignmentRequired *bool `json:"appRoleAssignmentRequired,omitempty"`
	// KeyCredentials - The collection of key credentials associated with the service principal.
	KeyCredentials *[]KeyCredential `json:"keyCredentials,omitempty"`
	// PasswordCredentials - The collection of password credentials associated with the service principal.
	PasswordCredentials *[]PasswordCredential `json:"passwordCredentials,omitempty"`
	// ServicePrincipalType - the type of the service principal
	ServicePrincipalType *string `json:"servicePrincipalType,omitempty"`
	// Tags - Optional list of tags that you can apply to your service principals. Not nullable.
	Tags *[]string `json:"tags,omitempty"`
}

ServicePrincipalCreateParameters request parameters for creating a new service principal.

type ServicePrincipalListResult

type ServicePrincipalListResult struct {
	autorest.Response `json:"-"`
	// Value - the list of service principals.
	Value *[]ServicePrincipal `json:"value,omitempty"`
	// OdataNextLink - the URL to get the next set of results.
	OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

ServicePrincipalListResult server response for get tenant service principals API call.

func (ServicePrincipalListResult) IsEmpty

func (splr ServicePrincipalListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type ServicePrincipalListResultIterator

type ServicePrincipalListResultIterator struct {
	// contains filtered or unexported fields
}

ServicePrincipalListResultIterator provides access to a complete listing of ServicePrincipal values.

func NewServicePrincipalListResultIterator

func NewServicePrincipalListResultIterator(page ServicePrincipalListResultPage) ServicePrincipalListResultIterator

Creates a new instance of the ServicePrincipalListResultIterator type.

func (*ServicePrincipalListResultIterator) Next

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ServicePrincipalListResultIterator) NextWithContext

func (iter *ServicePrincipalListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (ServicePrincipalListResultIterator) NotDone

NotDone returns true if the enumeration should be started or is not yet complete.

func (ServicePrincipalListResultIterator) Response

Response returns the raw server response from the last page request.

func (ServicePrincipalListResultIterator) Value

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type ServicePrincipalListResultPage

type ServicePrincipalListResultPage struct {
	// contains filtered or unexported fields
}

ServicePrincipalListResultPage contains a page of ServicePrincipal values.

func NewServicePrincipalListResultPage

Creates a new instance of the ServicePrincipalListResultPage type.

func (*ServicePrincipalListResultPage) Next

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*ServicePrincipalListResultPage) NextWithContext

func (page *ServicePrincipalListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (ServicePrincipalListResultPage) NotDone

func (page ServicePrincipalListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (ServicePrincipalListResultPage) Response

Response returns the raw server response from the last page request.

func (ServicePrincipalListResultPage) Values

Values returns the slice of values for the current page or nil if there are no values.

type ServicePrincipalObjectResult

type ServicePrincipalObjectResult struct {
	autorest.Response `json:"-"`
	// Value - The Object ID of the service principal with the specified application ID.
	Value *string `json:"value,omitempty"`
	// OdataMetadata - The URL representing edm equivalent.
	OdataMetadata *string `json:"odata.metadata,omitempty"`
}

ServicePrincipalObjectResult service Principal Object Result.

type ServicePrincipalUpdateParameters

type ServicePrincipalUpdateParameters struct {
	// AccountEnabled - whether or not the service principal account is enabled
	AccountEnabled *bool `json:"accountEnabled,omitempty"`
	// AppRoleAssignmentRequired - Specifies whether an AppRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application.
	AppRoleAssignmentRequired *bool `json:"appRoleAssignmentRequired,omitempty"`
	// KeyCredentials - The collection of key credentials associated with the service principal.
	KeyCredentials *[]KeyCredential `json:"keyCredentials,omitempty"`
	// PasswordCredentials - The collection of password credentials associated with the service principal.
	PasswordCredentials *[]PasswordCredential `json:"passwordCredentials,omitempty"`
	// ServicePrincipalType - the type of the service principal
	ServicePrincipalType *string `json:"servicePrincipalType,omitempty"`
	// Tags - Optional list of tags that you can apply to your service principals. Not nullable.
	Tags *[]string `json:"tags,omitempty"`
}

ServicePrincipalUpdateParameters request parameters for update an existing service principal.

type ServicePrincipalsClient

type ServicePrincipalsClient struct {
	BaseClient
}

ServicePrincipalsClient is the the Graph RBAC Management Client

func NewServicePrincipalsClient

func NewServicePrincipalsClient(tenantID string) ServicePrincipalsClient

NewServicePrincipalsClient creates an instance of the ServicePrincipalsClient client.

func NewServicePrincipalsClientWithBaseURI

func NewServicePrincipalsClientWithBaseURI(baseURI string, tenantID string) ServicePrincipalsClient

NewServicePrincipalsClientWithBaseURI creates an instance of the ServicePrincipalsClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (ServicePrincipalsClient) Create

Create creates a service principal in the directory. Parameters: parameters - parameters to create a service principal.

func (ServicePrincipalsClient) CreatePreparer

func (client ServicePrincipalsClient) CreatePreparer(ctx context.Context, parameters ServicePrincipalCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (ServicePrincipalsClient) CreateResponder

func (client ServicePrincipalsClient) CreateResponder(resp *http.Response) (result ServicePrincipal, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (ServicePrincipalsClient) CreateSender

func (client ServicePrincipalsClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (ServicePrincipalsClient) Delete

func (client ServicePrincipalsClient) Delete(ctx context.Context, objectID string) (result autorest.Response, err error)

Delete deletes a service principal from the directory. Parameters: objectID - the object ID of the service principal to delete.

func (ServicePrincipalsClient) DeletePreparer

func (client ServicePrincipalsClient) DeletePreparer(ctx context.Context, objectID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (ServicePrincipalsClient) DeleteResponder

func (client ServicePrincipalsClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (ServicePrincipalsClient) DeleteSender

func (client ServicePrincipalsClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (ServicePrincipalsClient) Get

func (client ServicePrincipalsClient) Get(ctx context.Context, objectID string) (result ServicePrincipal, err error)

Get gets service principal information from the directory. Query by objectId or pass a filter to query by appId Parameters: objectID - the object ID of the service principal to get.

func (ServicePrincipalsClient) GetPreparer

func (client ServicePrincipalsClient) GetPreparer(ctx context.Context, objectID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (ServicePrincipalsClient) GetResponder

func (client ServicePrincipalsClient) GetResponder(resp *http.Response) (result ServicePrincipal, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (ServicePrincipalsClient) GetSender

func (client ServicePrincipalsClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (ServicePrincipalsClient) List

func (client ServicePrincipalsClient) List(ctx context.Context, filter string) (result ServicePrincipalListResultPage, err error)

List gets a list of service principals from the current tenant. Parameters: filter - the filter to apply to the operation.

func (ServicePrincipalsClient) ListComplete

func (client ServicePrincipalsClient) ListComplete(ctx context.Context, filter string) (result ServicePrincipalListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (ServicePrincipalsClient) ListKeyCredentials

func (client ServicePrincipalsClient) ListKeyCredentials(ctx context.Context, objectID string) (result KeyCredentialListResult, err error)

ListKeyCredentials get the keyCredentials associated with the specified service principal. Parameters: objectID - the object ID of the service principal for which to get keyCredentials.

func (ServicePrincipalsClient) ListKeyCredentialsPreparer

func (client ServicePrincipalsClient) ListKeyCredentialsPreparer(ctx context.Context, objectID string) (*http.Request, error)

ListKeyCredentialsPreparer prepares the ListKeyCredentials request.

func (ServicePrincipalsClient) ListKeyCredentialsResponder

func (client ServicePrincipalsClient) ListKeyCredentialsResponder(resp *http.Response) (result KeyCredentialListResult, err error)

ListKeyCredentialsResponder handles the response to the ListKeyCredentials request. The method always closes the http.Response Body.

func (ServicePrincipalsClient) ListKeyCredentialsSender

func (client ServicePrincipalsClient) ListKeyCredentialsSender(req *http.Request) (*http.Response, error)

ListKeyCredentialsSender sends the ListKeyCredentials request. The method will close the http.Response Body if it receives an error.

func (ServicePrincipalsClient) ListNext

func (client ServicePrincipalsClient) ListNext(ctx context.Context, nextLink string) (result ServicePrincipalListResult, err error)

ListNext gets a list of service principals from the current tenant. Parameters: nextLink - next link for the list operation.

func (ServicePrincipalsClient) ListNextPreparer

func (client ServicePrincipalsClient) ListNextPreparer(ctx context.Context, nextLink string) (*http.Request, error)

ListNextPreparer prepares the ListNext request.

func (ServicePrincipalsClient) ListNextResponder

func (client ServicePrincipalsClient) ListNextResponder(resp *http.Response) (result ServicePrincipalListResult, err error)

ListNextResponder handles the response to the ListNext request. The method always closes the http.Response Body.

func (ServicePrincipalsClient) ListNextSender

func (client ServicePrincipalsClient) ListNextSender(req *http.Request) (*http.Response, error)

ListNextSender sends the ListNext request. The method will close the http.Response Body if it receives an error.

func (ServicePrincipalsClient) ListOwners

func (client ServicePrincipalsClient) ListOwners(ctx context.Context, objectID string) (result DirectoryObjectListResultPage, err error)

ListOwners the owners are a set of non-admin users who are allowed to modify this object. Parameters: objectID - the object ID of the service principal for which to get owners.

func (ServicePrincipalsClient) ListOwnersComplete

func (client ServicePrincipalsClient) ListOwnersComplete(ctx context.Context, objectID string) (result DirectoryObjectListResultIterator, err error)

ListOwnersComplete enumerates all values, automatically crossing page boundaries as required.

func (ServicePrincipalsClient) ListOwnersPreparer

func (client ServicePrincipalsClient) ListOwnersPreparer(ctx context.Context, objectID string) (*http.Request, error)

ListOwnersPreparer prepares the ListOwners request.

func (ServicePrincipalsClient) ListOwnersResponder

func (client ServicePrincipalsClient) ListOwnersResponder(resp *http.Response) (result DirectoryObjectListResult, err error)

ListOwnersResponder handles the response to the ListOwners request. The method always closes the http.Response Body.

func (ServicePrincipalsClient) ListOwnersSender

func (client ServicePrincipalsClient) ListOwnersSender(req *http.Request) (*http.Response, error)

ListOwnersSender sends the ListOwners request. The method will close the http.Response Body if it receives an error.

func (ServicePrincipalsClient) ListPasswordCredentials

func (client ServicePrincipalsClient) ListPasswordCredentials(ctx context.Context, objectID string) (result PasswordCredentialListResult, err error)

ListPasswordCredentials gets the passwordCredentials associated with a service principal. Parameters: objectID - the object ID of the service principal.

func (ServicePrincipalsClient) ListPasswordCredentialsPreparer

func (client ServicePrincipalsClient) ListPasswordCredentialsPreparer(ctx context.Context, objectID string) (*http.Request, error)

ListPasswordCredentialsPreparer prepares the ListPasswordCredentials request.

func (ServicePrincipalsClient) ListPasswordCredentialsResponder

func (client ServicePrincipalsClient) ListPasswordCredentialsResponder(resp *http.Response) (result PasswordCredentialListResult, err error)

ListPasswordCredentialsResponder handles the response to the ListPasswordCredentials request. The method always closes the http.Response Body.

func (ServicePrincipalsClient) ListPasswordCredentialsSender

func (client ServicePrincipalsClient) ListPasswordCredentialsSender(req *http.Request) (*http.Response, error)

ListPasswordCredentialsSender sends the ListPasswordCredentials request. The method will close the http.Response Body if it receives an error.

func (ServicePrincipalsClient) ListPreparer

func (client ServicePrincipalsClient) ListPreparer(ctx context.Context, filter string) (*http.Request, error)

ListPreparer prepares the List request.

func (ServicePrincipalsClient) ListResponder

func (client ServicePrincipalsClient) ListResponder(resp *http.Response) (result ServicePrincipalListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (ServicePrincipalsClient) ListSender

func (client ServicePrincipalsClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (ServicePrincipalsClient) Update

func (client ServicePrincipalsClient) Update(ctx context.Context, objectID string, parameters ServicePrincipalUpdateParameters) (result autorest.Response, err error)

Update updates a service principal in the directory. Parameters: objectID - the object ID of the service principal to delete. parameters - parameters to update a service principal.

func (ServicePrincipalsClient) UpdateKeyCredentials

func (client ServicePrincipalsClient) UpdateKeyCredentials(ctx context.Context, objectID string, parameters KeyCredentialsUpdateParameters) (result autorest.Response, err error)

UpdateKeyCredentials update the keyCredentials associated with a service principal. Parameters: objectID - the object ID for which to get service principal information. parameters - parameters to update the keyCredentials of an existing service principal.

func (ServicePrincipalsClient) UpdateKeyCredentialsPreparer

func (client ServicePrincipalsClient) UpdateKeyCredentialsPreparer(ctx context.Context, objectID string, parameters KeyCredentialsUpdateParameters) (*http.Request, error)

UpdateKeyCredentialsPreparer prepares the UpdateKeyCredentials request.

func (ServicePrincipalsClient) UpdateKeyCredentialsResponder

func (client ServicePrincipalsClient) UpdateKeyCredentialsResponder(resp *http.Response) (result autorest.Response, err error)

UpdateKeyCredentialsResponder handles the response to the UpdateKeyCredentials request. The method always closes the http.Response Body.

func (ServicePrincipalsClient) UpdateKeyCredentialsSender

func (client ServicePrincipalsClient) UpdateKeyCredentialsSender(req *http.Request) (*http.Response, error)

UpdateKeyCredentialsSender sends the UpdateKeyCredentials request. The method will close the http.Response Body if it receives an error.

func (ServicePrincipalsClient) UpdatePasswordCredentials

func (client ServicePrincipalsClient) UpdatePasswordCredentials(ctx context.Context, objectID string, parameters PasswordCredentialsUpdateParameters) (result autorest.Response, err error)

UpdatePasswordCredentials updates the passwordCredentials associated with a service principal. Parameters: objectID - the object ID of the service principal. parameters - parameters to update the passwordCredentials of an existing service principal.

func (ServicePrincipalsClient) UpdatePasswordCredentialsPreparer

func (client ServicePrincipalsClient) UpdatePasswordCredentialsPreparer(ctx context.Context, objectID string, parameters PasswordCredentialsUpdateParameters) (*http.Request, error)

UpdatePasswordCredentialsPreparer prepares the UpdatePasswordCredentials request.

func (ServicePrincipalsClient) UpdatePasswordCredentialsResponder

func (client ServicePrincipalsClient) UpdatePasswordCredentialsResponder(resp *http.Response) (result autorest.Response, err error)

UpdatePasswordCredentialsResponder handles the response to the UpdatePasswordCredentials request. The method always closes the http.Response Body.

func (ServicePrincipalsClient) UpdatePasswordCredentialsSender

func (client ServicePrincipalsClient) UpdatePasswordCredentialsSender(req *http.Request) (*http.Response, error)

UpdatePasswordCredentialsSender sends the UpdatePasswordCredentials request. The method will close the http.Response Body if it receives an error.

func (ServicePrincipalsClient) UpdatePreparer

func (client ServicePrincipalsClient) UpdatePreparer(ctx context.Context, objectID string, parameters ServicePrincipalUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (ServicePrincipalsClient) UpdateResponder

func (client ServicePrincipalsClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (ServicePrincipalsClient) UpdateSender

func (client ServicePrincipalsClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

type SignInName

type SignInName struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// Type - A string value that can be used to classify user sign-in types in your directory, such as 'emailAddress' or 'userName'.
	Type *string `json:"type,omitempty"`
	// Value - The sign-in used by the local account. Must be unique across the company/tenant. For example, 'johnc@example.com'.
	Value *string `json:"value,omitempty"`
}

SignInName contains information about a sign-in name of a local account user in an Azure Active Directory B2C tenant.

func (SignInName) MarshalJSON

func (sin SignInName) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for SignInName.

func (*SignInName) UnmarshalJSON

func (sin *SignInName) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for SignInName struct.

type SignedInUserClient

type SignedInUserClient struct {
	BaseClient
}

SignedInUserClient is the the Graph RBAC Management Client

func NewSignedInUserClient

func NewSignedInUserClient(tenantID string) SignedInUserClient

NewSignedInUserClient creates an instance of the SignedInUserClient client.

func NewSignedInUserClientWithBaseURI

func NewSignedInUserClientWithBaseURI(baseURI string, tenantID string) SignedInUserClient

NewSignedInUserClientWithBaseURI creates an instance of the SignedInUserClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (SignedInUserClient) Get

func (client SignedInUserClient) Get(ctx context.Context) (result User, err error)

Get gets the details for the currently logged-in user.

func (SignedInUserClient) GetPreparer

func (client SignedInUserClient) GetPreparer(ctx context.Context) (*http.Request, error)

GetPreparer prepares the Get request.

func (SignedInUserClient) GetResponder

func (client SignedInUserClient) GetResponder(resp *http.Response) (result User, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (SignedInUserClient) GetSender

func (client SignedInUserClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (SignedInUserClient) ListOwnedObjects

func (client SignedInUserClient) ListOwnedObjects(ctx context.Context) (result DirectoryObjectListResultPage, err error)

ListOwnedObjects get the list of directory objects that are owned by the user.

func (SignedInUserClient) ListOwnedObjectsComplete

func (client SignedInUserClient) ListOwnedObjectsComplete(ctx context.Context) (result DirectoryObjectListResultIterator, err error)

ListOwnedObjectsComplete enumerates all values, automatically crossing page boundaries as required.

func (SignedInUserClient) ListOwnedObjectsNext

func (client SignedInUserClient) ListOwnedObjectsNext(ctx context.Context, nextLink string) (result DirectoryObjectListResult, err error)

ListOwnedObjectsNext get the list of directory objects that are owned by the user. Parameters: nextLink - next link for the list operation.

func (SignedInUserClient) ListOwnedObjectsNextPreparer

func (client SignedInUserClient) ListOwnedObjectsNextPreparer(ctx context.Context, nextLink string) (*http.Request, error)

ListOwnedObjectsNextPreparer prepares the ListOwnedObjectsNext request.

func (SignedInUserClient) ListOwnedObjectsNextResponder

func (client SignedInUserClient) ListOwnedObjectsNextResponder(resp *http.Response) (result DirectoryObjectListResult, err error)

ListOwnedObjectsNextResponder handles the response to the ListOwnedObjectsNext request. The method always closes the http.Response Body.

func (SignedInUserClient) ListOwnedObjectsNextSender

func (client SignedInUserClient) ListOwnedObjectsNextSender(req *http.Request) (*http.Response, error)

ListOwnedObjectsNextSender sends the ListOwnedObjectsNext request. The method will close the http.Response Body if it receives an error.

func (SignedInUserClient) ListOwnedObjectsPreparer

func (client SignedInUserClient) ListOwnedObjectsPreparer(ctx context.Context) (*http.Request, error)

ListOwnedObjectsPreparer prepares the ListOwnedObjects request.

func (SignedInUserClient) ListOwnedObjectsResponder

func (client SignedInUserClient) ListOwnedObjectsResponder(resp *http.Response) (result DirectoryObjectListResult, err error)

ListOwnedObjectsResponder handles the response to the ListOwnedObjects request. The method always closes the http.Response Body.

func (SignedInUserClient) ListOwnedObjectsSender

func (client SignedInUserClient) ListOwnedObjectsSender(req *http.Request) (*http.Response, error)

ListOwnedObjectsSender sends the ListOwnedObjects request. The method will close the http.Response Body if it receives an error.

type User

type User struct {
	autorest.Response `json:"-"`
	// ImmutableID - This must be specified if you are using a federated domain for the user's userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
	ImmutableID *string `json:"immutableId,omitempty"`
	// UsageLocation - A 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. Examples include: "US", "JP", and "GB".
	UsageLocation *string `json:"usageLocation,omitempty"`
	// GivenName - The given name for the user.
	GivenName *string `json:"givenName,omitempty"`
	// Surname - The user's surname (family name or last name).
	Surname *string `json:"surname,omitempty"`
	// UserType - A string value that can be used to classify user types in your directory, such as 'Member' and 'Guest'. Possible values include: 'Member', 'Guest'
	UserType UserType `json:"userType,omitempty"`
	// AccountEnabled - Whether the account is enabled.
	AccountEnabled *bool `json:"accountEnabled,omitempty"`
	// DisplayName - The display name of the user.
	DisplayName *string `json:"displayName,omitempty"`
	// UserPrincipalName - The principal name of the user.
	UserPrincipalName *string `json:"userPrincipalName,omitempty"`
	// MailNickname - The mail alias for the user.
	MailNickname *string `json:"mailNickname,omitempty"`
	// Mail - The primary email address of the user.
	Mail *string `json:"mail,omitempty"`
	// SignInNames - The sign-in names of the user.
	SignInNames *[]SignInName `json:"signInNames,omitempty"`
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// ObjectID - READ-ONLY; The object ID.
	ObjectID *string `json:"objectId,omitempty"`
	// DeletionTimestamp - READ-ONLY; The time at which the directory object was deleted.
	DeletionTimestamp *date.Time `json:"deletionTimestamp,omitempty"`
	// ObjectType - Possible values include: 'ObjectTypeDirectoryObject', 'ObjectTypeApplication', 'ObjectTypeGroup', 'ObjectTypeServicePrincipal', 'ObjectTypeUser'
	ObjectType ObjectType `json:"objectType,omitempty"`
}

User active Directory user information.

func (User) AsADGroup

func (u User) AsADGroup() (*ADGroup, bool)

AsADGroup is the BasicDirectoryObject implementation for User.

func (User) AsApplication

func (u User) AsApplication() (*Application, bool)

AsApplication is the BasicDirectoryObject implementation for User.

func (User) AsBasicDirectoryObject

func (u User) AsBasicDirectoryObject() (BasicDirectoryObject, bool)

AsBasicDirectoryObject is the BasicDirectoryObject implementation for User.

func (User) AsDirectoryObject

func (u User) AsDirectoryObject() (*DirectoryObject, bool)

AsDirectoryObject is the BasicDirectoryObject implementation for User.

func (User) AsServicePrincipal

func (u User) AsServicePrincipal() (*ServicePrincipal, bool)

AsServicePrincipal is the BasicDirectoryObject implementation for User.

func (User) AsUser

func (u User) AsUser() (*User, bool)

AsUser is the BasicDirectoryObject implementation for User.

func (User) MarshalJSON

func (u User) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for User.

func (*User) UnmarshalJSON

func (u *User) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for User struct.

type UserBase

type UserBase struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// ImmutableID - This must be specified if you are using a federated domain for the user's userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
	ImmutableID *string `json:"immutableId,omitempty"`
	// UsageLocation - A 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. Examples include: "US", "JP", and "GB".
	UsageLocation *string `json:"usageLocation,omitempty"`
	// GivenName - The given name for the user.
	GivenName *string `json:"givenName,omitempty"`
	// Surname - The user's surname (family name or last name).
	Surname *string `json:"surname,omitempty"`
	// UserType - A string value that can be used to classify user types in your directory, such as 'Member' and 'Guest'. Possible values include: 'Member', 'Guest'
	UserType UserType `json:"userType,omitempty"`
}

UserBase ...

func (UserBase) MarshalJSON

func (ub UserBase) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UserBase.

func (*UserBase) UnmarshalJSON

func (ub *UserBase) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UserBase struct.

type UserCreateParameters

type UserCreateParameters struct {
	// AccountEnabled - Whether the account is enabled.
	AccountEnabled *bool `json:"accountEnabled,omitempty"`
	// DisplayName - The display name of the user.
	DisplayName *string `json:"displayName,omitempty"`
	// PasswordProfile - Password Profile
	PasswordProfile *PasswordProfile `json:"passwordProfile,omitempty"`
	// UserPrincipalName - The user principal name (someuser@contoso.com). It must contain one of the verified domains for the tenant.
	UserPrincipalName *string `json:"userPrincipalName,omitempty"`
	// MailNickname - The mail alias for the user.
	MailNickname *string `json:"mailNickname,omitempty"`
	// Mail - The primary email address of the user.
	Mail *string `json:"mail,omitempty"`
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// ImmutableID - This must be specified if you are using a federated domain for the user's userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
	ImmutableID *string `json:"immutableId,omitempty"`
	// UsageLocation - A 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. Examples include: "US", "JP", and "GB".
	UsageLocation *string `json:"usageLocation,omitempty"`
	// GivenName - The given name for the user.
	GivenName *string `json:"givenName,omitempty"`
	// Surname - The user's surname (family name or last name).
	Surname *string `json:"surname,omitempty"`
	// UserType - A string value that can be used to classify user types in your directory, such as 'Member' and 'Guest'. Possible values include: 'Member', 'Guest'
	UserType UserType `json:"userType,omitempty"`
}

UserCreateParameters request parameters for creating a new work or school account user.

func (UserCreateParameters) MarshalJSON

func (ucp UserCreateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UserCreateParameters.

func (*UserCreateParameters) UnmarshalJSON

func (ucp *UserCreateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UserCreateParameters struct.

type UserGetMemberGroupsParameters

type UserGetMemberGroupsParameters struct {
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// SecurityEnabledOnly - If true, only membership in security-enabled groups should be checked. Otherwise, membership in all groups should be checked.
	SecurityEnabledOnly *bool `json:"securityEnabledOnly,omitempty"`
}

UserGetMemberGroupsParameters request parameters for GetMemberGroups API call.

func (UserGetMemberGroupsParameters) MarshalJSON

func (ugmgp UserGetMemberGroupsParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UserGetMemberGroupsParameters.

func (*UserGetMemberGroupsParameters) UnmarshalJSON

func (ugmgp *UserGetMemberGroupsParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UserGetMemberGroupsParameters struct.

type UserGetMemberGroupsResult

type UserGetMemberGroupsResult struct {
	autorest.Response `json:"-"`
	// Value - A collection of group IDs of which the user is a member.
	Value *[]string `json:"value,omitempty"`
}

UserGetMemberGroupsResult server response for GetMemberGroups API call.

type UserListResult

type UserListResult struct {
	autorest.Response `json:"-"`
	// Value - the list of users.
	Value *[]User `json:"value,omitempty"`
	// OdataNextLink - The URL to get the next set of results.
	OdataNextLink *string `json:"odata.nextLink,omitempty"`
}

UserListResult server response for Get tenant users API call.

func (UserListResult) IsEmpty

func (ulr UserListResult) IsEmpty() bool

IsEmpty returns true if the ListResult contains no values.

type UserListResultIterator

type UserListResultIterator struct {
	// contains filtered or unexported fields
}

UserListResultIterator provides access to a complete listing of User values.

func NewUserListResultIterator

func NewUserListResultIterator(page UserListResultPage) UserListResultIterator

Creates a new instance of the UserListResultIterator type.

func (*UserListResultIterator) Next

func (iter *UserListResultIterator) Next() error

Next advances to the next value. If there was an error making the request the iterator does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*UserListResultIterator) NextWithContext

func (iter *UserListResultIterator) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next value. If there was an error making the request the iterator does not advance and the error is returned.

func (UserListResultIterator) NotDone

func (iter UserListResultIterator) NotDone() bool

NotDone returns true if the enumeration should be started or is not yet complete.

func (UserListResultIterator) Response

func (iter UserListResultIterator) Response() UserListResult

Response returns the raw server response from the last page request.

func (UserListResultIterator) Value

func (iter UserListResultIterator) Value() User

Value returns the current value or a zero-initialized value if the iterator has advanced beyond the end of the collection.

type UserListResultPage

type UserListResultPage struct {
	// contains filtered or unexported fields
}

UserListResultPage contains a page of User values.

func NewUserListResultPage

func NewUserListResultPage(cur UserListResult, getNextPage func(context.Context, UserListResult) (UserListResult, error)) UserListResultPage

Creates a new instance of the UserListResultPage type.

func (*UserListResultPage) Next

func (page *UserListResultPage) Next() error

Next advances to the next page of values. If there was an error making the request the page does not advance and the error is returned. Deprecated: Use NextWithContext() instead.

func (*UserListResultPage) NextWithContext

func (page *UserListResultPage) NextWithContext(ctx context.Context) (err error)

NextWithContext advances to the next page of values. If there was an error making the request the page does not advance and the error is returned.

func (UserListResultPage) NotDone

func (page UserListResultPage) NotDone() bool

NotDone returns true if the page enumeration should be started or is not yet complete.

func (UserListResultPage) Response

func (page UserListResultPage) Response() UserListResult

Response returns the raw server response from the last page request.

func (UserListResultPage) Values

func (page UserListResultPage) Values() []User

Values returns the slice of values for the current page or nil if there are no values.

type UserType

type UserType string

UserType enumerates the values for user type.

const (
	// Guest ...
	Guest UserType = "Guest"
	// Member ...
	Member UserType = "Member"
)

func PossibleUserTypeValues

func PossibleUserTypeValues() []UserType

PossibleUserTypeValues returns an array of possible values for the UserType const type.

type UserUpdateParameters

type UserUpdateParameters struct {
	// AccountEnabled - Whether the account is enabled.
	AccountEnabled *bool `json:"accountEnabled,omitempty"`
	// DisplayName - The display name of the user.
	DisplayName *string `json:"displayName,omitempty"`
	// PasswordProfile - The password profile of the user.
	PasswordProfile *PasswordProfile `json:"passwordProfile,omitempty"`
	// UserPrincipalName - The user principal name (someuser@contoso.com). It must contain one of the verified domains for the tenant.
	UserPrincipalName *string `json:"userPrincipalName,omitempty"`
	// MailNickname - The mail alias for the user.
	MailNickname *string `json:"mailNickname,omitempty"`
	// AdditionalProperties - Unmatched properties from the message are deserialized this collection
	AdditionalProperties map[string]interface{} `json:""`
	// ImmutableID - This must be specified if you are using a federated domain for the user's userPrincipalName (UPN) property when creating a new user account. It is used to associate an on-premises Active Directory user account with their Azure AD user object.
	ImmutableID *string `json:"immutableId,omitempty"`
	// UsageLocation - A 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. Examples include: "US", "JP", and "GB".
	UsageLocation *string `json:"usageLocation,omitempty"`
	// GivenName - The given name for the user.
	GivenName *string `json:"givenName,omitempty"`
	// Surname - The user's surname (family name or last name).
	Surname *string `json:"surname,omitempty"`
	// UserType - A string value that can be used to classify user types in your directory, such as 'Member' and 'Guest'. Possible values include: 'Member', 'Guest'
	UserType UserType `json:"userType,omitempty"`
}

UserUpdateParameters request parameters for updating an existing work or school account user.

func (UserUpdateParameters) MarshalJSON

func (uup UserUpdateParameters) MarshalJSON() ([]byte, error)

MarshalJSON is the custom marshaler for UserUpdateParameters.

func (*UserUpdateParameters) UnmarshalJSON

func (uup *UserUpdateParameters) UnmarshalJSON(body []byte) error

UnmarshalJSON is the custom unmarshaler for UserUpdateParameters struct.

type UsersClient

type UsersClient struct {
	BaseClient
}

UsersClient is the the Graph RBAC Management Client

func NewUsersClient

func NewUsersClient(tenantID string) UsersClient

NewUsersClient creates an instance of the UsersClient client.

func NewUsersClientWithBaseURI

func NewUsersClientWithBaseURI(baseURI string, tenantID string) UsersClient

NewUsersClientWithBaseURI creates an instance of the UsersClient client using a custom endpoint. Use this when interacting with an Azure cloud that uses a non-standard base URI (sovereign clouds, Azure stack).

func (UsersClient) Create

func (client UsersClient) Create(ctx context.Context, parameters UserCreateParameters) (result User, err error)

Create create a new user. Parameters: parameters - parameters to create a user.

func (UsersClient) CreatePreparer

func (client UsersClient) CreatePreparer(ctx context.Context, parameters UserCreateParameters) (*http.Request, error)

CreatePreparer prepares the Create request.

func (UsersClient) CreateResponder

func (client UsersClient) CreateResponder(resp *http.Response) (result User, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (UsersClient) CreateSender

func (client UsersClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (UsersClient) Delete

func (client UsersClient) Delete(ctx context.Context, upnOrObjectID string) (result autorest.Response, err error)

Delete delete a user. Parameters: upnOrObjectID - the object ID or principal name of the user to delete.

func (UsersClient) DeletePreparer

func (client UsersClient) DeletePreparer(ctx context.Context, upnOrObjectID string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (UsersClient) DeleteResponder

func (client UsersClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (UsersClient) DeleteSender

func (client UsersClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (UsersClient) Get

func (client UsersClient) Get(ctx context.Context, upnOrObjectID string) (result User, err error)

Get gets user information from the directory. Parameters: upnOrObjectID - the object ID or principal name of the user for which to get information.

func (UsersClient) GetMemberGroups

func (client UsersClient) GetMemberGroups(ctx context.Context, objectID string, parameters UserGetMemberGroupsParameters) (result UserGetMemberGroupsResult, err error)

GetMemberGroups gets a collection that contains the object IDs of the groups of which the user is a member. Parameters: objectID - the object ID of the user for which to get group membership. parameters - user filtering parameters.

func (UsersClient) GetMemberGroupsPreparer

func (client UsersClient) GetMemberGroupsPreparer(ctx context.Context, objectID string, parameters UserGetMemberGroupsParameters) (*http.Request, error)

GetMemberGroupsPreparer prepares the GetMemberGroups request.

func (UsersClient) GetMemberGroupsResponder

func (client UsersClient) GetMemberGroupsResponder(resp *http.Response) (result UserGetMemberGroupsResult, err error)

GetMemberGroupsResponder handles the response to the GetMemberGroups request. The method always closes the http.Response Body.

func (UsersClient) GetMemberGroupsSender

func (client UsersClient) GetMemberGroupsSender(req *http.Request) (*http.Response, error)

GetMemberGroupsSender sends the GetMemberGroups request. The method will close the http.Response Body if it receives an error.

func (UsersClient) GetPreparer

func (client UsersClient) GetPreparer(ctx context.Context, upnOrObjectID string) (*http.Request, error)

GetPreparer prepares the Get request.

func (UsersClient) GetResponder

func (client UsersClient) GetResponder(resp *http.Response) (result User, err error)

GetResponder handles the response to the Get request. The method always closes the http.Response Body.

func (UsersClient) GetSender

func (client UsersClient) GetSender(req *http.Request) (*http.Response, error)

GetSender sends the Get request. The method will close the http.Response Body if it receives an error.

func (UsersClient) List

func (client UsersClient) List(ctx context.Context, filter string, expand string) (result UserListResultPage, err error)

List gets list of users for the current tenant. Parameters: filter - the filter to apply to the operation. expand - the expand value for the operation result.

func (UsersClient) ListComplete

func (client UsersClient) ListComplete(ctx context.Context, filter string, expand string) (result UserListResultIterator, err error)

ListComplete enumerates all values, automatically crossing page boundaries as required.

func (UsersClient) ListNext

func (client UsersClient) ListNext(ctx context.Context, nextLink string) (result UserListResult, err error)

ListNext gets a list of users for the current tenant. Parameters: nextLink - next link for the list operation.

func (UsersClient) ListNextPreparer

func (client UsersClient) ListNextPreparer(ctx context.Context, nextLink string) (*http.Request, error)

ListNextPreparer prepares the ListNext request.

func (UsersClient) ListNextResponder

func (client UsersClient) ListNextResponder(resp *http.Response) (result UserListResult, err error)

ListNextResponder handles the response to the ListNext request. The method always closes the http.Response Body.

func (UsersClient) ListNextSender

func (client UsersClient) ListNextSender(req *http.Request) (*http.Response, error)

ListNextSender sends the ListNext request. The method will close the http.Response Body if it receives an error.

func (UsersClient) ListPreparer

func (client UsersClient) ListPreparer(ctx context.Context, filter string, expand string) (*http.Request, error)

ListPreparer prepares the List request.

func (UsersClient) ListResponder

func (client UsersClient) ListResponder(resp *http.Response) (result UserListResult, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (UsersClient) ListSender

func (client UsersClient) ListSender(req *http.Request) (*http.Response, error)

ListSender sends the List request. The method will close the http.Response Body if it receives an error.

func (UsersClient) Update

func (client UsersClient) Update(ctx context.Context, upnOrObjectID string, parameters UserUpdateParameters) (result autorest.Response, err error)

Update updates a user. Parameters: upnOrObjectID - the object ID or principal name of the user to update. parameters - parameters to update an existing user.

func (UsersClient) UpdatePreparer

func (client UsersClient) UpdatePreparer(ctx context.Context, upnOrObjectID string, parameters UserUpdateParameters) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (UsersClient) UpdateResponder

func (client UsersClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (UsersClient) UpdateSender

func (client UsersClient) UpdateSender(req *http.Request) (*http.Response, error)

UpdateSender sends the Update request. The method will close the http.Response Body if it receives an error.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL