Purpose

To create and modify a user as well as update password of a user using Sectona API interface.

Accessing the API

Endpoint: /API/APP/APP007/ManageUser
XML


HTTP METHOD

POST
XML


Parameters

ParametersData TypeRequiredDescription

APIActionType

String

YES

Create
Modify
UpdatePassword

AuthenticationType


String


YES


Sectona Authentication
Windows Active Directory

DirectoryStore

String

OPTIONAL

It is mandatory if the authentication type is windows active directory

Username

String

YES

Username to create user

Password

String

OPTIONAL

Password for user to create an option for directory store only

FirstName

String

OPTIONAL

First name of user

LastName

String

OPTIONAL

Last name of user

MobileNo

String

OPTIONAL

Mobile number of user

Company

String

OPTIONAL

Company name of user

EmailID

Email

OPTIONAL

Email ID of user

Manager

String

OPTIONAL

Manager name of user

Department

String

OPTIONAL

Department of user

DevoidSecurity


true/false


OPTIONAL


Specify to allow devoid security to user. Default is false.

UserRole

String

YES

User roles from Sectona to assign user

UserAccessPolicy


String


OPTIONAL


Default policy will be assigned to any policy not specified.

Expiry


Date in String


OPTIONAL


Specifies the expiry of user. If unspecified, then considered as user will never expire.

Instance

String

OPTIONAL

Specifies to create an instance

Tags

String

OPTIONAL

Specifies tags to identify user

IsActive


true/false


YES


Specify user enabled in Sectona. Default is enabled.

UnlockUser

true/false

YES

It is useful for update user


Sample Request (JSON)

{
	 "APIActionType":"Create/Modify/UpdatePassword",
     "AuthenticationType":"String",
     "DirectoryStore":"String",
     "Username":"String",
     "NewUsername":"String",
     "Password":"String",
     "FirstName":"String",
     "LastName":"String",
     "MobileNo":"Mobile number",
     "Company":"String",
     "EmailID":"Email",
     "Manager":"String",
     "Department":"String",
     "DevoidSecurity":"True/False",
     "UserRole":"String",
     "UserAccessPolicy":"String",
     "Expiry":"Date in String",
     "Instance":"String",
     "Tags":"String",
     "IsActive":"True/False",
     "UnlockUser":"True/False",

}

XML


Sample Response (JSON)

{
	"Version":"3.7.0.0",
	"IsSuccess”: true,
	"LogCode":"0",
	"Message":"user XXXX(XXX XXX) created/modified successfully / Password changed for user XXXX(XXX XXX)",
	"StatusCode":"OK",
	"Timestamp":"22 Apr 2019 13:10:54 GMT 05:30:00"
}

XML


Standard Error Response Codes

Error Code

Error Description

11649

Current user does not have permission to create user

11651

The authorization header is empty or not basic

11673

Invalid credentials

11674

Invalid credentials

11675

Unable to validate request

11683

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

Authentication Type, Username, and directory store cannot be changed in modify API Action type.