HomeGuidesAPI ReferenceChangelogDiscussions
GuidesiMIS ProfessionaliMIS EnterpriseClient SupportLog In
API Reference
These docs are for v20.3.44. Click to read the latest docs for v20.3.189.

Executes a GenericExecuteRequest

Executes an operation of UserSecurity

With the UserSecurity service you can perform the following operations on the execute endpoint:

  • Find by Name
  • Update by UserName
  • Update by UserName and send email
  • Update Password
  • Get User Roles
  • Add User Roles
  • Remove User Roles
  • Get User Claims
  • Unlock User
  • Validate User

Find by Name

BODY PARAMS:
{
    "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
    "EntityTypeName": "UserSecurity",
    "OperationName": "FindByName",
    "Parameters": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
        "$values": [
            "UserName"
        ]
    },
    "UseJson": false,
    "ParameterTypeNames": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
        "$values": [
            "System.String"
        ]
    }
}

Update by UserName

BODY PARAMS:
{
    "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
    "EntityTypeName": "UserSecurity",
    "OperationName": "UpdateUserName",
    "Parameters": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
        "$values": [
            "OldUserName",
            "NewUserName",
            "Password",
            false
        ]
    },
    "UseJson": false,
    "ParameterTypeNames": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
        "$values": [
            "System.String",
            "System.String",
            "System.String",
            "System.Boolean"
        ]
    }
}

Update by UserName and send email

BODY PARAMS:
{
    "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
    "EntityTypeName": "UserSecurity",
    "OperationName": "UpdateUserName",
    "Parameters": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
        "$values": [
            "OldUserName",
            "NewUserName",
            "Password",
            true
        ]
    },
    "UseJson": false,
    "ParameterTypeNames": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
        "$values": [
            "System.String",
            "System.String",
            "System.String",
            "System.Boolean"
        ]
    }
}

Update Password

BODY PARAMS:
{
    "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
    "EntityTypeName": "UserSecurity",
    "OperationName": "UpdatePassword",
    "Parameters": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
        "$values": [
            "UserName",
            "OldPassword",
            "NewPassword"
        ]
    },
    "UseJson": false,
    "ParameterTypeNames": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
        "$values": [
            "System.String",
            "System.String",
            "System.String"
        ]
    }
}

Get User Roles

BODY PARAMS:
{
    "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
    "EntityTypeName": "UserSecurity",
    "OperationName": "GetUserRoles",
    "Parameters": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
        "$values": [
            "UserName"
        ]
    },
    "UseJson": false,
    "ParameterTypeNames": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
        "$values": [
            "System.String"
        ]
    }
}

Add User Roles

BODY PARAMS:
{
    "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
    "EntityTypeName": "UserSecurity",
    "OperationName": "AddUserRoles",
    "Parameters": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
        "$values": [
            "UserName",
            {
                "$type": "System.Collections.Generic.List`1[[Asi.Soa.Membership.DataContracts.User.RoleData, Asi.Contracts]], mscorlib",
                "$values": [
                    {
                        "$type": "Asi.Soa.Membership.DataContracts.User.RoleData, Asi.Contracts",
                        "RoleKey": "8E5C7C1D-170B-4294-B646-2E60D2091DF8"
                    }
                ]
            }
        ]
    },
    "UseJson": false,
    "ParameterTypeNames": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
        "$values": [
            "System.String",
            "System.Collections.Generic.List`1[[Asi.Soa.Membership.DataContracts.User.RoleData, Asi.Contracts]], mscorlib"
        ]
    }
}

Remove User Roles

BODY PARAMS:
{
    "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
    "EntityTypeName": "UserSecurity",
    "OperationName": "RemoveUserRoles",
    "Parameters": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
        "$values": [
            "UserName",
            {
                "$type": "System.Collections.Generic.List`1[[Asi.Soa.Membership.DataContracts.User.RoleData, Asi.Contracts]], mscorlib",
                "$values": [
                    {
                        "$type": "Asi.Soa.Membership.DataContracts.User.RoleData, Asi.Contracts",
                        "RoleKey": "8E5C7C1D-170B-4294-B646-2E60D2091DF8"
                    }
                ]
            }
        ]
    },
    "UseJson": false,
    "ParameterTypeNames": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
        "$values": [
            "System.String",
            "System.Collections.Generic.List`1[[Asi.Soa.Membership.DataContracts.User.RoleData, Asi.Contracts]], mscorlib"
        ]
    }
}

Get User Claims

BODY PARAMS:
{
    "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
    "EntityTypeName": "UserSecurity",
    "OperationName": "GetUserClaims",
    "Parameters": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
        "$values": [
            "UserId"
        ]
    },
    "UseJson": false,
    "ParameterTypeNames": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
        "$values": [
            "System.String"
        ]
    }
}

Unlock User

BODY PARAMS:
{
    "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
    "EntityTypeName": "UserSecurity",
    "OperationName": "UnlockUser",
    "Parameters": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
        "$values": [
            "UserName"
        ]
    },
    "UseJson": false,
    "ParameterTypeNames": {
        "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
        "$values": [
            "System.String"
        ]
    }
}

Validate User

BODY PARAMS:
{
"$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
"EntityTypeName": "UserSecurity",
"OperationName": "ValidateUser",
"Parameters": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
    "$values": [
        "UserName",
        "Password"
    ]
},
"UseJson": false,
"ParameterTypeNames": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
    "$values": [
        "System.String",
        "System.String"
    ]
}

}

Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!