UserContract Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface UserContract

An immutable client-side representation of UserContract.

Method Summary

Modifier and Type	Method and Description
abstract String	email() Gets the email property: Email address.
abstract String	firstName() Gets the firstName property: First name.
abstract GenerateSsoUrlResult	generateSsoUrl() Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.
abstract Response<GenerateSsoUrlResult>	generateSsoUrlWithResponse(Context context) Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.
abstract UserTokenResult	getSharedAccessToken(UserTokenParameters parameters) Gets the Shared Access Authorization Token for the User.
abstract Response<UserTokenResult>	getSharedAccessTokenWithResponse(UserTokenParameters parameters, Context context) Gets the Shared Access Authorization Token for the User.
abstract List<GroupContractProperties>	groups() Gets the groups property: Collection of groups user is part of.
abstract String	id() Gets the id property: Fully qualified resource Id for the resource.
abstract List<UserIdentityContract>	identities() Gets the identities property: Collection of user identities.
abstract UserContractInner	innerModel() Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.UserContractInner object.
abstract String	lastName() Gets the lastName property: Last name.
abstract String	name() Gets the name property: The name of the resource.
abstract String	note() Gets the note property: Optional note about a user set by the administrator.
abstract UserContract	refresh() Refreshes the resource to sync with Azure.
abstract UserContract	refresh(Context context) Refreshes the resource to sync with Azure.
abstract OffsetDateTime	registrationDate() Gets the registrationDate property: Date of user registration.
abstract String	resourceGroupName() Gets the name of the resource group.
abstract UserState	state() Gets the state property: Account state.
abstract String	type() Gets the type property: The type of the resource.
abstract Update	update() Begins update for the UserContract resource.

Method Details

email

public abstract String email()

Gets the email property: Email address.

Returns:

the email value.

firstName

public abstract String firstName()

Gets the firstName property: First name.

Returns:

the firstName value.

generateSsoUrl

public abstract GenerateSsoUrlResult generateSsoUrl()

Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.

Returns:

generate SSO Url operations response details.

generateSsoUrlWithResponse

public abstract Response generateSsoUrlWithResponse(Context context)

Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.

Parameters:

context - The context to associate with this operation.

Returns:

generate SSO Url operations response details along with Response<T>.

getSharedAccessToken

public abstract UserTokenResult getSharedAccessToken(UserTokenParameters parameters)

Gets the Shared Access Authorization Token for the User.

Parameters:

parameters - Create Authorization Token parameters.

Returns:

the Shared Access Authorization Token for the User.

getSharedAccessTokenWithResponse

public abstract Response getSharedAccessTokenWithResponse(UserTokenParameters parameters, Context context)

Gets the Shared Access Authorization Token for the User.

Parameters:

parameters - Create Authorization Token parameters.

context - The context to associate with this operation.

Returns:

the Shared Access Authorization Token for the User along with Response<T>.

groups

public abstract List groups()

Gets the groups property: Collection of groups user is part of.

Returns:

the groups value.

id

public abstract String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

identities

public abstract List identities()

Gets the identities property: Collection of user identities.

Returns:

the identities value.

innerModel

public abstract UserContractInner innerModel()

Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.UserContractInner object.

Returns:

the inner object.

lastName

public abstract String lastName()

Gets the lastName property: Last name.

Returns:

the lastName value.

name

public abstract String name()

Gets the name property: The name of the resource.

Returns:

the name value.

note

public abstract String note()

Gets the note property: Optional note about a user set by the administrator.

Returns:

the note value.

refresh

public abstract UserContract refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

public abstract UserContract refresh(Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

registrationDate

public abstract OffsetDateTime registrationDate()

Gets the registrationDate property: Date of user registration. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.

Returns:

the registrationDate value.

resourceGroupName

public abstract String resourceGroupName()

Gets the name of the resource group.

Returns:

the name of the resource group.

state

public abstract UserState state()

Gets the state property: Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.

Returns:

the state value.

type

public abstract String type()

Gets the type property: The type of the resource.

Returns:

the type value.

update

public abstract UserContract.Update update()

Begins update for the UserContract resource.

Returns:

the stage of resource update.