HomeGuidesAPI ReferenceChangelogDiscussions
GuidesiMIS ProfessionaliMIS EnterpriseClient SupportLog In
API Reference

Executes a UserSecurity operation

Executes an operation of UserSecurity

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

  • FindByName
  • UpdateUserName
  • UpdatePassword
  • GetUserRoles
  • AddUserRoles
  • RemoveUserRoles
  • GetUserClaims
  • UnlockUser
  • ValidateUser

FindByName

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

UpdateUserName

BODY PARAMS:
{
  "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
  "OperationName": "UpdateUserName",
  "EntityTypeName": "UserSecurity",
  "Parameters": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
    "$values": [
      {
        "$type": "System.String",
        "$value": "oldUserName Value"
      },
      {
        "$type": "System.String",
        "$value": "newUserName Value"
      },
      {
        "$type": "System.String",
        "$value": "password Value"
      },
      {
        "$type": "System.Boolean",
        "$value": "sendChangeEmail Value"
      }
    ]
  },
  "ParameterTypeName": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
    "$values": [
      "System.String",
      "System.String",
      "System.String",
      "System.Boolean"
    ]
  },
  "UseJson": false
}

UpdatePassword

BODY PARAMS:
{
  "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
  "OperationName": "UpdatePassword",
  "EntityTypeName": "UserSecurity",
  "Parameters": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
    "$values": [
      {
        "$type": "System.String",
        "$value": "userName Value"
      },
      {
        "$type": "System.String",
        "$value": "oldPassword Value"
      },
      {
        "$type": "System.String",
        "$value": "newPassword Value"
      }
    ]
  },
  "ParameterTypeName": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
    "$values": [
      "System.String",
      "System.String",
      "System.String"
    ]
  },
  "UseJson": false
}

GetUserRoles

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

AddUserRoles

BODY PARAMS:
{
  "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
  "OperationName": "AddUserRoles",
  "EntityTypeName": "UserSecurity",
  "Parameters": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
    "$values": [
      {
        "$type": "System.String",
        "$value": "userName Value"
      },
      {
        "$type": "System.Collections.Generic.List`1[[Asi.Soa.Membership.DataContracts.User.RoleData, Asi.Contracts]]",
        "$value": "rolesToAdd Value"
      }
    ]
  },
  "ParameterTypeName": {
    "$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]]"
    ]
  },
  "UseJson": false
}

RemoveUserRoles

BODY PARAMS:
{
  "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
  "OperationName": "RemoveUserRoles",
  "EntityTypeName": "UserSecurity",
  "Parameters": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
    "$values": [
      {
        "$type": "System.String",
        "$value": "userName Value"
      },
      {
        "$type": "System.Collections.Generic.List`1[[Asi.Soa.Membership.DataContracts.User.RoleData, Asi.Contracts]]",
        "$value": "rolesToRemove Value"
      }
    ]
  },
  "ParameterTypeName": {
    "$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]]"
    ]
  },
  "UseJson": false
}

GetUserClaims

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

UnlockUser

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

ValidateUser

BODY PARAMS:
{
  "$type": "Asi.Soa.Core.DataContracts.GenericExecuteRequest, Asi.Contracts",
  "OperationName": "ValidateUser",
  "EntityTypeName": "UserSecurity",
  "Parameters": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.Object, mscorlib]], mscorlib",
    "$values": [
      {
        "$type": "System.String",
        "$value": "userName Value"
      },
      {
        "$type": "System.String",
        "$value": "password Value"
      }
    ]
  },
  "ParameterTypeName": {
    "$type": "System.Collections.ObjectModel.Collection`1[[System.String, mscorlib]], mscorlib",
    "$values": [
      "System.String",
      "System.String"
    ]
  },
  "UseJson": false
}
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!