Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Login, Logout, Change Password, Reset Password API

Application deploys with default 1 admin user with all permission over all data models of user management as well as applications. Admin user can login and create more users and define other roles with capabilities. Admin user can grant ReadWrite, ReadOnly and Hidden permission to the data models. Admin user can give ReadWrite access to the other roles also for creation of roles, capabilities and users. 

Default username/Password : Admin/Pass@123

userToken and appName : Requester can provide this values in headers or URL arguments.

TypeAPI URLRequestHeaderResponse
Loginhttps://<server>:<port>/fid-Authentication/loginEmpty

Authorization: Basic
Username : Admin
Password : Pass@123

Response
<Auth>
  <Status>Success</Status>
  <Message>Login Successful</Message>
  <Token>uqhjrf7ba4qauv7i1551009679429</Token>
  <Expiry>1551020479429</Expiry>
  <RoleID>AdminRoleId</RoleID>
</Auth>
Logouthttps://<server>:<port>/fid-Authentication/logoutEmptyuserToken:{{userToken}}
Response
<Auth>
  <Status>Success</Status>
  <Message>User session ended successfully.</Message>
</Auth>
Change Passwordhttp://<server>:<port>/fid-UserManagement
Request
<ChangePassword>
	<userName>Admin</userName>
	<oldPassword>Pass@123</oldPassword>
	<password>Jack@123</password>
</ChangePassword>
Content-Type:application/xml
userToken:{{userToken}}
appName:UM
Response
<Auth>
    <Status>Success</Status>
    <Message>Password changed successfully.</Message>
</Auth>
Reset Passwordhttp://<server>:<port>/fid-UserManagement
Request
<ResetPassword>
	<userName>Admin</userName>
</ResetPassword>
Content-Type:application/xml
userToken:{{superUser}}
appName:UM
Response
<Auth>
    <Status>Success</Status>
    <Message>Password reset successfully.</Message>
</Auth>

Create User, Role, Capability, Mappings, Permission

TypeAPI URLRequestHeaderResponse
Userhttp://<server>:<port>/fid-UserManagement
Request
<CreateUser>
	<firstName>Tony</firstName>
	<lastName>Stark</lastName>
	<userName>Stark</userName>
	<emailId>Stark@gmail.com</emailId>
	<roleId>OperatorRoleId</roleId>
</CreateUser>
userToken:{{userToken}}
Content-Type:application/xml
appName:UM
Response
<Create>
    <Status>
		Success
	</Status>
    <Message>
		User 
		Created 
		Successfully
	</Message>
    <UserId>
		udbshj
	</UserId>
</Create>

User
Details

http://<server>:<port>/fid-UserManagement
Request
<find  only="username,firstname, lastname, emailId, roleid">
	<User>
		<username>Admin</username>
	</User>
</find>
userToken:{{userToken}}
Content-Type:application/xml
appName:UM
Response
<Find Status="Success">
    <Result>
        <User>
            <emailId>kishorekislay007@gmail.com</emailId>
            <lastName>Admin</lastName>
            <roleId>AdminRoleId</roleId>
            <userName>Admin</userName>
            <firstName>Admin</firstName>
        </User>
    </Result>
</Find>
Rolehttp://<server>:<port>/fid-UserManagement
Request
<Create>
	<Role>
		<SysId>OperatorRoleId</SysId>
	    <roleName>Operator</roleName>
	    <description>Operator</description>
	    <createDate>[:$Now():]</createDate>
	</Role>
</Create>
Content-Type:application/xml
userToken:{{userToken}}
appName:UM

Create Success Response Message

Role
Details

http://<server>:<port>/fid-UserManagement
Request
<find>
	<role>
		<sysid>AdminRoleId</sysid>
	</role>
</find>
Content-Type:application/xml
userToken:{{userToken}}
appName:UM
Response
<Find Status="Success">
    <Result>
        <Role>
            <sysId>AdminRoleId</sysId>
            <roleName>Admin</roleName>
            <description>Administrator</description>
            <createDate>1550934717348</createDate>
        </Role>
    </Result>
</Find>
Capabilityhttp://<server>:<port>/fid-UserManagement
Request
<Create>
    <Capability>
        <SysId>
			OperatorMonitoringCapability
		</SysId>
      	<capabilityName>
			OperatorMonitoringCapability
		</capabilityName>
        <description>
			ReadWrite Capabilities for all roles
	    </description>
        <createDate>[:$Now():]</createDate>
    </Capability>
</Create>
Content-Type:text/xml
userToken:{{userToken}}
appName:UM


Create Success Response Message

Mappingshttp://<server>:<port>/fid-UserManagement
Request
<Create>
    <RoleCapabilityMapping>
        <SysId>OperatorControlMapping</SysId>
        <roleId>OperatorRoleId</roleId>
        <capabilityId>OperatorMonitoringCapability</capabilityId>
        <permission>ReadWrite</permission>
    </RoleCapabilityMapping>
	<CapabilityModelAssociation>
        <capabilityId>OperatorMonitoringCapability</capabilityId>
        <associationData>Atomiton.UserManagement.User</associationData>
        <resolveIndex>1</resolveIndex>
        <appModel>false</appModel>
    </CapabilityModelAssociation>   
</Create>
	<RoleBasedModelModifiersHTTP>
	    <roleKey>OperatorRoleId</roleKey>
	</RoleBasedModelModifiersHTTP>
	<AppModelModifiersHTTP>
		<roleKey>OperatorRoleId</roleKey>
		<appName>HelloTQL</appName>
	</AppModelModifiersHTTP>
Content-Type:application/xml
userToken:{{userToken}}
appName:UM		Create Success Response Message

Create
RoleTab
Mapping

http://<server>:<port>/fid-UserManagement
Request
<Create>
	<RoleMenuTabMapping>
		<roleID>AdminRoleId</roleID>
		<menuTabName>UMFunctionality</menuTabName>
	</RoleMenuTabMapping>
</Create>
Content-Type:application/xml
userToken:{{userToken}}
appName:UM		Create Success Response Message

Find
RoleTab
Mapping

http://<server>:<port>/fid-UserManagement
Reuqest
<find>
	<RoleMenuTabMapping>
		<roleID>AdminRoleId</roleID>
	</RoleMenuTabMapping>
</find>
Content-Type:application/xml
userToken:{{userToken}}
appName:UM
Response
<Find Status="Success">
    <Result>
        <RoleMenuTabMapping>
            <sysId>NEXSBB23AAAKYHY5WTS6LWLD</sysId>
            <menuTabName>UMFunctionality</menuTabName>
            <roleID>AdminRoleId</roleID>
        </RoleMenuTabMapping>
    </Result>
</Find>

Other Requests

TypeAPI URLRequestHeaderResponse

Application
Requests

http://<server>:<port>/fid-UserManagement
Request
<find>
    <RGBModel>
        <rgbId ne=""/>
    </RGBModel>
</find>
<find>
    <VendorInfo>
        <vendorId ne=""/>
    </VendorInfo>
</find>
<find>
    <HiddenModel>
        <Id ne=""/>
    </HiddenModel>
</find>
Content-Type:text/xml
userToken:{{userToken}}
appName:{{appName}}		Application Request response
UM
Requests		http://<server>:<port>/fid-UserManagement
Request
<find>
	<UserPasswords>
		<sysid ne=""/>
	</UserPasswords>
</find>
Content-Type:application/xml
userToken:{{userToken}}
appName:UM		User Management Request response
  • No labels