Web Service Details: UserService

Seekda Community Feedback

• UserServicePort (Protocol: SOAP11_HTTP)

  • CreateAuthenticator
    Allows a user to create an authenticator used when ordering data from a provider. A provider may create authenticator definitions for authentication information that is required when ordering. If a provider requires an authenticator (credentials) from the user, the user must create one and set it on the order before submitting it.
    Input: CreateAuthenticator
    Output: CreateAuthenticatorResponse
  • CreateUser
    Creates a new user in the ECHO system. The user account will be available for immediate use. Some restrictions are enforced when creating a new user: The user ID must be less than 30 characters. The user ID must be unique. The user domain and region cannot be set to unspecified. The password must between 10 and 40 characters (inclusive). The password must contain at least 3 different character types: uppercase, lowercase, digits, or special characters.
    Input: CreateUser
    Output: CreateUserResponse
  • GetAuthenticatorNames
    Returns the names and guids of all the authenticators defined for the given provider for the current user.
    Input: GetAuthenticatorNames
    Output: GetAuthenticatorNamesResponse
  • GetAuthenticators
    Returns the authenticators for the given authenticator Guids.
    Input: GetAuthenticators
    Output: GetAuthenticatorsResponse
  • GetCurrentUser
    Returns the user information for the current user. Only registered users (not guests) can get their user information. If an administrator is acting as another user, the information for the act as user will be returned.
    Input: GetCurrentUser
    Output: GetCurrentUserResponse
  • GetUserNames
    Returns the user ID and guids for users based on the given guids. This operation requires a registered user.
    Input: GetUserNames
    Output: GetUserNamesResponse
  • GetUserNamesByOrganizationAndFirstAndLastName
    This operation requires Provider or Administrator access.Returns the user ID and guid for users based on the given fields. All the users in the system are searched.
    Input: GetUserNamesByOrganizationAndFirstAndLastName
    Output: GetUserNamesByOrganizationAndFirstAndLastNameResponse
  • GetUserNamesByRole
    This operation requires Provider or Administrator access.Returns the user IDs and guids for users with the given role. The caller must either be an Administrator or a provider requesting a username for someone with the same provider role.
    Input: GetUserNamesByRole
    Output: GetUserNamesByRoleResponse
  • GetUserNamesByUserId
    Returns the user IDs and Guids for users based on user IDs.
    Input: GetUserNamesByUserId
    Output: GetUserNamesByUserIdResponse
  • GetUserPreferences
    Returns the user preferences for the current user. If the user does not have user preferences established, this method will return null.
    Input: GetUserPreferences
    Output: GetUserPreferencesResponse
  • GetUsers
    This operation requires Provider or Administrator access. Returns the user information for the given user Guids. Only an administrator or a provider may present user information for other users. Administrators have access to all the user information. Providers can only retrieve user id, organization name, first name, last name, user domain, and user region.
    Input: GetUsers
    Output: GetUsersResponse
  • GrantAccess
    This operation requires Provider or Administrator access.Grants access to the given users. An administrator may grant any access, but a provider may only grant access to its own provider role.
    Input: GrantAccess
    Output: GrantAccessResponse
  • RecallUserId
    Allows a user to recall his or her username using the e-mail address which user registered with ECHO. The usernames will be sent to the email address this user specified. ECHO does not throw an exception when this method is called with an invalid or unknown email address. As a best practice clients should display the submitted email address to the user after invoking this operation. This operation is available to registered users and guests.
    Input: RecallUserId
    Output: RecallUserIdResponse
  • RemoveAuthenticators
    Removes one or more previously defined authenticators from the current user.
    Input: RemoveAuthenticators
    Output: RemoveAuthenticatorsResponse
  • RemoveUserPreferences
    Removes the user preferences for the current user. If no preferences have been established, this operation will throw an exception.
    Input: RemoveUserPreferences
    Output: RemoveUserPreferencesResponse
  • RemoveUsers
    This operation requires Administrator access.Removes the users with the given user guids.
    Input: RemoveUsers
    Output: RemoveUsersResponse
  • ResetUserPassword
    Allows a user to reset his or her password. The new random password will be sent to the email address this user specified. ECHO does not throw an exception when this method is called with an invalid or unknown email address. As a best practice clients should display the submitted email address to the user after invoking this operation. This operation is available to registered users and guests.
    Input: ResetUserPassword
    Output: ResetUserPasswordResponse
  • RevokeAccess
    This operation requires Provider or Administrator access.Revokes access to the given users. An administrator may revoke any access, but a provider may only revoke access to its own provider role.
    Input: RevokeAccess
    Output: RevokeAccessResponse
  • SetUserPassword
    This message allows a user to change password. The old password is required for regular user for security reasons, however, it is not required for administrator.
    Input: SetUserPassword
    Output: SetUserPasswordResponse
  • SetUserPreferences
    Sets the user preferences for the given user. If the user already has preferences established, this operation will replace those preferences. If the user does not have preferences established yet, the preferences given will be set as the active preferences.
    Input: SetUserPreferences
    Output: SetUserPreferencesResponse
  • UpdateAuthenticators
    Updates an authenticator definition in ECHO. If the authenticator does not already exist, an error is raised. The owner guid can not be changed in an authenticator.
    Input: UpdateAuthenticators
    Output: UpdateAuthenticatorsResponse
  • UpdateUsers
    Update persisted user's information including first name, last name, email address, domain, region, and/or organization name. User domain and region cannot be set to unspecified. The user roles will be ignored in this operation. They can only be updated by granting or revoking access. The user name field will be ignored during update.
    Input: UpdateUsers
    Output: UpdateUsersResponse