API - Manage User | Sectona Docs

Purpose

To create and modify a user and update a user's password using the Sectona API interface.

Accessing the API

XML

Endpoint: /API/APP/APP007/ManageUser

HTTP METHOD

XML

POST

Parameters

Parameters	Data Type	Required	Description
APIActionType	String	Yes	Create OR Modify OR UpdatePassword
AuthenticationType	String	No	Authentication type
DirectoryStore	String	No	Directory store name of user (Required if authentication type is other than SectonaAuthentication)
Username	String	Yes	Username of user
Password	String	No	Password of user (Required if authentication type is SectonaAuthentication)
FirstName	String	No	First name of user (Required if authentication type is SectonaAuthentication)
LastName	String	No	Last name of user (Required if authentication type is SectonaAuthentication)
Mobile	String	No	Mobile number of user
Company	String	No	Company name of user
EmailID	String	No	Email ID of user (Required if authentication type is "GenericSAML")
Manager	String	No	Manager name of user
Department	String	No	Department name of user
CustomAttribute1	String	No	Value of custom attribute 1
CustomAttribute2	String	No	Value of custom attribute 2
DevoidSecurity	Boolean	No	Specify to allow devoid security for user. Default it is false
UserRole	String	No	User role to be assign
UserType	String	No	Interactive OR APIOAuth OR InteractiveAPIOAuth
UserLogonPolicy	String	No	Default policy will be assigned if logon policy name not provided
Expiry	Date	No	It specifies the expiry of user. If not provided, considered as user will never expire.
NewDirectoryStore	String	No	Directory store name of user (Required if authentication type is other than SectonaAuthentication) Applicable when APIActionType is Modify
UnlockUser	Boolean	No	Unlock the user. Applicable when APIActionType is Modify
Instance	String	No	Instance name required if system running with MSP license
Tags	String	No	Tags to be assigned to user (multiple tags can be provided by comma separated)
IsActive	Boolean	No	User status in system. Default it is enabled

Sample Request (JSON)

XML

{
	"APIActionType":"Create/Modify/UpdatePassword",
     "AuthenticationType":"Authentication type",
     "DirectoryStore":"Directory store name",
     "Username":"Username",
     "Password":"Password",
     "FirstName":"First name",
     "LastName":"Last name",
     "Mobile":"Mobile No.",
     "Company":"Company",
     "EmailID":"Email ID",
     "Manager":"Manager",
     "Department":"Department",
     "CustomAttribute1":"Custom attribute 1",
     "CustomAttribute2":"Custom attribute 2",
     "DevoidSecurity":true/false,
     "UserRole":"User role",
     "UserType":"Interactive/APIOAuth/InteractiveAPIOAuth",
     "UserLogonPolicy":"User logon policy name",
     "Expiry":"Expiry date",
     "NewDirectoryStore":"New Directory store name",
     "UnlockUser":true/false,
     "Instance":"Instance name",
     "Tags":"Tag name 1,Tag name 2,…,Tag name n",
     "IsActive":true/false,
}

Sample Response (JSON)

XML

{
   "IsSuccess": true,
   "LogCode": 0,
   "Result": "User *username* created/ modified successfully ",
   "StatusCode": 200,
   "Timestamp": "28 Apr 2026 16:13:08 GMT 05:30:00",
   "Version": "6.0.0.0"
}

Standard Error Response Codes

Error Code	Error Description
011649	Current users do not have permission to take an action
011651	The authorization header is either empty or not basic
011673	Invalid credentials
011674	Invalid credentials
011675	Unable to validate request
011683	Invalid instance name
011803	Unable to insert API log details
032401	The system was unable to create user
011669	Unable to create user
011676	Unable to get user properties
011677	Unable to perform action
011805	Unable to get user group
011849	The system was unable to load tags information
011852	Error in processing
011661	Invalid tags

The authentication type, username, and directory store cannot be changed using the modify API action.