Перейти к основному содержимому
Версия: Indeed Access Manager 8.2

UserCatalog

Информация

Пример функций на PowerShell: ссылка

getObjects

Возвращает данные объекта каталога пользователя Indeed АМ по внутреннему идентификатору. 

POST /api/v5/userCatalog/getObjects
Объект запроса
{  
  "Ids": [
    "string"
  ],
  "AccessToken": "string",
  "ApplicationId": "string"
}

в объекте запроса:

  • Ids — массив внутренних идентификаторов.
  • AccessToken — обязательный параметр. Токен администратора, от имени которого выполняется запрос к API. 
  • ApplicationId — обязательный параметр. Строковый идентификатор модуля Indeed AM.
Объект ответа
{  
  "Id": "string",
  "RawObjectId": "string",
  "Name": "string",
  "CanonicalName": "string",
  "PrincipalName": "string",
  "SamCompatibleName": "string",
  "DistinguishedName": "string",
  "Sid": "string",
  "IsGroup": true,
  "IsContainer": true,
  "IsRemoved": true,
  "GroupsIds": [
    "string"
  ],
  "ContainerId": "string"
}

searchUsers

Поиск пользователя по входным параметрам.

POST /api/v5/userCatalog/searchUsers
Объект запроса
{  
  "Operation": 0,
  "Filters": [
    {
      "AttributeName": "string",
      "Value": {},
      "Negation": true
    }
  ],
  "Limit": 0,
  "LoadParentObjects": true,
  "AccessToken": "string",
  "ApplicationId": "string"
}

в объекте запроса:

  • Operation:
    • 0 — ИЛИ;
    • 1 — И;
  • Filters - массив фильтров для поиска:
    • AttributeName — имя атрибута Active Directory для поиска;
    • Value  — значение атрибута Active Directory для поиска;
    • Negation — отрицание заданного фильтра. Значения true\false
Объект ответа
[  
  {
    "FirstName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Email": "string",
    "Phone": "string",
    "IsDisabled": true,
    "IsLocked": true,
    "Id": "string",
    "RawObjectId": "string",
    "Name": "string",
    "CanonicalName": "string",
    "PrincipalName": "string",
    "SamCompatibleName": "string",
    "DistinguishedName": "string",
    "Sid": "string",
    "IsGroup": true,
    "IsContainer": true,
    "IsRemoved": true,
    "GroupsIds": [
      "string"
    ],
    "ContainerId": "string"
  }
]

searchGroups

Поиск группы по входным параметрам.

POST /api/v5/userCatalog/searchGroups
Объект запроса
{  
  "Operation": 0,
  "Filters": [
    {
      "AttributeName": "string",
      "Value": {},
      "Negation": true
    }
  ],
  "Limit": 0,
  "LoadParentObjects": true,
  "AccessToken": "string",
  "ApplicationId": "string"
}

в объекте запроса:

  • Operation:
    • 0 — ИЛИ;
    • 1 — И;
  • Filters — массив фильтров для поиска:
    • AttributeName — имя атрибута Active Directory для поиска;
    • Value  — значение атрибута Active Directory для поиска;
    • Negation — отрицание заданного фильтра. Значения true\false
Объект ответа
[  
  {
    "FirstName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Email": "string",
    "Phone": "string",
    "IsDisabled": true,
    "IsLocked": true,
    "Id": "string",
    "RawObjectId": "string",
    "Name": "string",
    "CanonicalName": "string",
    "PrincipalName": "string",
    "SamCompatibleName": "string",
    "DistinguishedName": "string",
    "Sid": "string",
    "IsGroup": true,
    "IsContainer": true,
    "IsRemoved": true,
    "GroupsIds": [
      "string"
    ],
    "ContainerId": "string"
  }
]

searchContainers

Поиск подразделения по входным параметрам. 

POST /api/v5/userCatalog/searchContainers
Объект запроса
{  
  "Operation": 0,
  "Filters": [
    {
      "AttributeName": "string",
      "Value": {},
      "Negation": true
    }
  ],
  "Limit": 0,
  "LoadParentObjects": true,
  "AccessToken": "string",
  "ApplicationId": "string"
}

в объекте запроса:

  • Operation:
    • 0 — ИЛИ;
    • 1 — И;
  • Filters — массив фильтров для поиска:
    • AttributeName — имя атрибута Active Directory для поиска;
    • Value  — значение атрибута Active Directory для поиска;
    • Negation — отрицание заданного фильтра. Значения true\false
Объект ответа
[  
  {
    "FirstName": "string",
    "MiddleName": "string",
    "LastName": "string",
    "Email": "string",
    "Phone": "string",
    "IsDisabled": true,
    "IsLocked": true,
    "Id": "string",
    "RawObjectId": "string",
    "Name": "string",
    "CanonicalName": "string",
    "PrincipalName": "string",
    "SamCompatibleName": "string",
    "DistinguishedName": "string",
    "Sid": "string",
    "IsGroup": true,
    "IsContainer": true,
    "IsRemoved": true,
    "GroupsIds": [
      "string"
    ],
    "ContainerId": "string"
  }
]