Visit Platform at http://www.platform.com

UsersService

Operation: LogonUser This operation is used to establish a session for the user.
Input Message

The request contains no sub-elements.

Output Message

The response contains the following sub-element.

  • CredentialToken - this element contains the Credential.

Operation: VerifyUserCredential This operation is used to verify the user credentials.
Input Message

The request contains the following sub-element.

  • CredentialToken - this element contains the Credential.
Output Message

The response contains the following sub-element.

  • Valid - boolean reply.

Operation: RefreshUserCredential This operation is used to refresh the user credentials.
Input Message

The request contains no sub-element.

Output Message

The response contains the following sub-element.

  • CredentialToken - this element contains the Credential.

Operation: LogoffUser This operation is used to end a session for the user.
Input Message

The request contains no sub-elements.

Output Message

The response contains no sub-element.


Operation: ManageUser This operation is used to manage a principal within the EGO User Database. The operation is driven by the ManageUserOperation element. Only cluster_admin can perform this operation.
Input Message

The request contains the following sub-elements:

  • ManageUserOperation - this element indicates which operation is being performed, and can be one of "add", "modify", or "delete".
  • The next element is a Choice element that is determined by the operation being performed.
    • "add" - the UserEntry element is used to add a new principal to the database.
    • "modify" - the UserEntry element is used to modify the properties of an existing EGO principal.
    • "delete" - the User element is used to name the principal that should be removed from the database.
Output Message

Currently, the response message from ManageUser is an empty element tag (<ManageUserResponse/>).


Operation: QueryUsers This operation provides a mechanism for getting a list of principals from the EGO user database.
Input Message

Currently, the request message for QueryUsers is an empty element tag (<QueryUsersRequest/>).

Output Message

Zero or more UserEntry elements are returned.


Operation: ManageRole This operation is used to manage the EGO roles that a principal in the EGO user database has assigned. Currently in EGO, the only roles supported are "cluster_admin", "consumer_admin", and "consumer_user".
Input Message

The request message has the following sub-elements:

  • ManageRoleOperation - the string "add" or "remove" which indicates whether a user is being given a role, or having it removed.
  • Role - the role to be assigned or removed.
  • User - the user to which the operation will be applied.
  • Option - there are no options defined at this time.
Output Message

Currently, the response message from ManageRole is an empty element tag (<ManageRoleResponse/>).


Operation: QueryRoles This operation is used to query which roles are assigned to users. Two flavours of query are supported: one can ask which users are assigned a named role, or which roles are assigned to a user, depending on the format of the request message. Currently, EGO only supports the roles "cluster_admin", "consumer_admin", and "consumer_user".
Input Message

The request message is a choice element. A Role is specified if one would like to request which users have the named role, and a User is specified if one would like to find out which roles have been assigned to a particular user.

Output Message

The response message is a choice element. Zero or more User elements are returned if the request contained a Role, and zero or more Role elements are returned if the request contained a User.


Operation: RefreshCredential This operation is used to refresh the user credentials.
Input Message

The request contains no sub-element.

Output Message

The response contains the following sub-element.

  • Credential - this element contains the Credential.



Date Modified: 26 Nov 2007
Platform Computing: www.platform.com

Platform Support: support@platform.com
Platform Information Development: doc@platform.com

Copyright © 1994-2007 Platform Computing Corporation. All rights reserved.