Package com.azure.resourcemanager.apimanagement.models

Interface UserContract

  • public interface UserContract
    An immutable client-side representation of UserContract.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • firstName

        String firstName()
        Gets the firstName property: First name.
        Returns:
        the firstName value.

      • lastName

        String lastName()
        Gets the lastName property: Last name.
        Returns:
        the lastName value.

      • email

        String email()
        Gets the email property: Email address.
        Returns:
        the email value.

      • registrationDate

        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.

      • groups

        List<GroupContractProperties> groups()
        Gets the groups property: Collection of groups user is part of.
        Returns:
        the groups value.

      • state

        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.

      • note

        String note()
        Gets the note property: Optional note about a user set by the administrator.
        Returns:
        the note value.

      • identities

        List<UserIdentityContract> identities()
        Gets the identities property: Collection of user identities.
        Returns:
        the identities value.

      • innerModel

        UserContractInner innerModel()
        Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.UserContractInner object.
        Returns:
        the inner object.

      • update

        UserContract.Update update()
        Begins update for the UserContract resource.
        Returns:
        the stage of resource update.

      • refresh

        UserContract refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        UserContract refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • generateSsoUrl

        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.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • generateSsoUrlWithResponse

        com.azure.core.http.rest.Response<GenerateSsoUrlResult> generateSsoUrlWithResponse​(com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getSharedAccessToken

        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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • getSharedAccessTokenWithResponse

        com.azure.core.http.rest.Response<UserTokenResult> getSharedAccessTokenWithResponse​(UserTokenParameters parameters,
                                                                                    com.azure.core.util.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.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.