Перейти к основному содержимому

Сервис управления сущностями ApiResource.

/services/identityadminapi/api/ApiResources/GetAll

Возвращает список всех доступных сущностей OpenIdConnect.

Тип HTTP запроса: post

Отсылаемый запрос

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultApiResourceResult[]Данные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/GetOneById

Возвращает информацию о сущности по идентификатору.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Уникальный идентификатор сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultApiResourceResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/GetOneByName

Возвращает ApiResource по имени.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Имя ApiResource.

Название поляТип поляОписаниеОбязательноеВозможные значения
namestringИмя записи.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultApiResourceResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Create

Добавляет новую сущность.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Данные новой сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
namestringИмя ApiResource.да
displayNamestringОтображаемое имя ApiResource.да
descriptionstringОписание ApiResource.нет
allowedAccessTokenSigningAlgorithmsstringДоступный алгоритм подписи токенов.нет
showInDiscoveryDocumentbooleanФлаг, определяющий, показывать ли информацию о ресурсе в DiscoveryDocument Identity.нет
enabledbooleanСостояние активности ApiResource.нет
nonEditablebooleanФлаг неизменяемости ресурса.нет
scopesValueItem[]Список областей видимости, привязанных к ресурсу.нет

Возвращаемые результаты

Код HTTP ответа: 201

MIME-тип HTTP ответа: application/json

Created

Название поляТип поляОписаниеОбязательноеВозможные значения
resultIdResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 400

MIME-тип HTTP ответа: application/json

Bad Request

Название поляТип поляОписаниеОбязательноеВозможные значения
typestringнет
titlestringнет
statusinteger (int32)нет
detailstringнет
instancestringнет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Update

Обновляет данные о сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Данные обновляемой сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор сущности.да
namestringИмя ApiResource.да
displayNamestringОтображаемое имя ApiResource.да
descriptionstringОписание ApiResource.нет
allowedAccessTokenSigningAlgorithmsstringДоступный алгоритм подписи токенов.нет
showInDiscoveryDocumentbooleanФлаг, определяющий, показывать ли информацию о ресурсе в DiscoveryDocument Identity.нет
enabledbooleanСостояние активности ApiResource.нет
nonEditablebooleanФлаг неизменяемости ресурса.нет
scopesValueItem[]Список областей видимости, привязанных к ресурсу.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Delete

Удаляет сущность.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Уникальный идентификатор сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Secrets/GetAll

Возвращает список секретных ключей указанной сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Уникальный идентификатор сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultApiResourceSecretsResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Secrets/GetOne

Возвращает данные по указанному секретному ключу.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Уникальный идентификатор секретного ключа.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultApiResourceSecretResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Secrets/Create

Добавляет секретный ключ указанной сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Данные добавляемого секретного ключа.

Название поляТип поляОписаниеОбязательноеВозможные значения
apiResourceIdinteger (int32)Уникальный идентификатор ApiResource.да
valuestringЗначение секретного ключа.нет
descriptionstringОписание секретного ключа.нет
expirationstring (date-time)Время жизни секретного ключа.нет
typestringТип секретного ключа.нет

Возвращаемые результаты

Код HTTP ответа: 201

MIME-тип HTTP ответа: application/json

Created

Название поляТип поляОписаниеОбязательноеВозможные значения
resultIdResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 400

MIME-тип HTTP ответа: application/json

Bad Request

Название поляТип поляОписаниеОбязательноеВозможные значения
typestringнет
titlestringнет
statusinteger (int32)нет
detailstringнет
instancestringнет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Secrets/Delete

Удаляет секретный ключ.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Уникальный идентификатор секретного ключа.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Claims/GetAll

Возвращает список Claims сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Идентификатор сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultTypesResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Claims/GetOne

Возвращает Claim сущности по идентификатору.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Идентификатор Claim сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultTypeResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Claims/Create

Добавляет Claim сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Параметры добавления Claim сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
entryOwnerIdinteger (int32)Уникальный идентификатор сущности, к которой относится значение.да
typestringТип сущности.да

Возвращаемые результаты

Код HTTP ответа: 201

MIME-тип HTTP ответа: application/json

Created

Название поляТип поляОписаниеОбязательноеВозможные значения
resultIdResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 400

MIME-тип HTTP ответа: application/json

Bad Request

Название поляТип поляОписаниеОбязательноеВозможные значения
typestringнет
titlestringнет
statusinteger (int32)нет
detailstringнет
instancestringнет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Claims/Update

Обновляет Claim сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Параметры обновления Claim сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор сущности.да
entryOwnerIdinteger (int32)Уникальный идентификатор сущности, к которой относится значение.да
typestringТип сущности.да

Возвращаемые результаты

Код HTTP ответа: 201

MIME-тип HTTP ответа: application/json

Created

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 400

MIME-тип HTTP ответа: application/json

Bad Request

Название поляТип поляОписаниеОбязательноеВозможные значения
typestringнет
titlestringнет
statusinteger (int32)нет
detailstringнет
instancestringнет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Claims/Delete

Удаляет Claim сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Идентификатор Claim сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Properties/GetAll

Возвращает список свойств сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Идентификатор сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultKeyValuesResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Properties/GetOne

Возвращает свойство сущности по идентификатору.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Идентификатор свойства сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultKeyValueResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Properties/Create

Добавляет свойство сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Параметры добавления свойства сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
keystringКлюч сущности.да
entryOwnerIdinteger (int32)Уникальный идентификатор сущности, к которой относится значение.да
valuestringЗначение сущности.да

Возвращаемые результаты

Код HTTP ответа: 201

MIME-тип HTTP ответа: application/json

Created

Название поляТип поляОписаниеОбязательноеВозможные значения
resultIdResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 400

MIME-тип HTTP ответа: application/json

Bad Request

Название поляТип поляОписаниеОбязательноеВозможные значения
typestringнет
titlestringнет
statusinteger (int32)нет
detailstringнет
instancestringнет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Properties/Update

Обновляет свойство сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Параметры обновления свойства сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор сущности.да
keystringКлюч сущности.да
entryOwnerIdinteger (int32)Уникальный идентификатор сущности, к которой относится значение.да
valuestringЗначение сущности.да

Возвращаемые результаты

Код HTTP ответа: 201

MIME-тип HTTP ответа: application/json

Created

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 400

MIME-тип HTTP ответа: application/json

Bad Request

Название поляТип поляОписаниеОбязательноеВозможные значения
typestringнет
titlestringнет
statusinteger (int32)нет
detailstringнет
instancestringнет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Properties/Delete

Удаляет свойство сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Идентификатор свойства сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Scopes/GetAll

Возвращает список Scopes указанной сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Идентификатор сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultValuesResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Scopes/GetOne

Возвращает Scope сущности по идентификатору.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Идентификатор Scope сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultValueResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Scopes/Create

Добавляет Scope сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Данные нового Scope.

Название поляТип поляОписаниеОбязательноеВозможные значения
entryOwnerIdinteger (int32)Уникальный идентификатор сущности, к которой относится значение.да
valuestringЗначение сущности.да

Возвращаемые результаты

Код HTTP ответа: 201

MIME-тип HTTP ответа: application/json

Created

Название поляТип поляОписаниеОбязательноеВозможные значения
resultIdResultда
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 400

MIME-тип HTTP ответа: application/json

Bad Request

Название поляТип поляОписаниеОбязательноеВозможные значения
typestringнет
titlestringнет
statusinteger (int32)нет
detailstringнет
instancestringнет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Scopes/Update

Обновляет Scope сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Данные обновляемого Scope.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор сущности.да
entryOwnerIdinteger (int32)Уникальный идентификатор сущности, к которой относится значение.да
valuestringЗначение сущности.да

Возвращаемые результаты

Код HTTP ответа: 201

MIME-тип HTTP ответа: application/json

Created

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 400

MIME-тип HTTP ответа: application/json

Bad Request

Название поляТип поляОписаниеОбязательноеВозможные значения
typestringнет
titlestringнет
statusinteger (int32)нет
detailstringнет
instancestringнет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

/services/identityadminapi/api/ApiResources/Scopes/Delete

Удаляет Scope сущности.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Идентификатор Scope сущности.

Название поляТип поляОписаниеОбязательноеВозможные значения
idinteger (int32)Уникальный идентификатор.нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultstringДанные результата метода API.да
errorInfoда
typeInfoTypeInfo

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden