Chatta subito con l'assistenza

Ottieni assistenza in tempo reale
Completa la registrazione

Accedi

Richiedi prezzo

Contatta il supporto vendite

Identity Manager 9.1.1 - API Development Guide

Table of Contents

About this guide Basic principles of API development

API Server basics

General information about the API Server Calling the API Server web interface Encryption General notes on programming your own API methods

Guidelines and conventions

Handling of API Server queries Authentication

Configuring authentication Authentication (primary) Logging out

Session status and security tokens

Querying session status

Limiting results Sort order Filtering Grouping Hierarchical data structure Additional query parameters Type-safe classes

User-defined methods SQL methods

HTTP methods Date formats Parameter formats

Path parameters Query parameters

Response formats Response codes Avoiding deadlocks

Examples and help – Software Development Kit Implementing your own APIs

Managing API plug-ins

Creating API plug-ins Editing API plug-ins Compiling TypeScript API clients

Adding APIs to One Identity API projects Creating API projects Adding APIs to your own API projects

ImxClient command line program

Starting the ImxClient command line program ImxClient command overview

check-translations compile-api compile-app connect edit-config fetch-files get-apistate get-filestate help inject-package install-apiserver push-files repl run-apiserver start-update workspace-info

Response codes

Basic principles of API development > Guidelines and conventions > Response codes

Responses that are sent from the REST API use the following codes. If queries fail, an explanatory error message is displayed.

Response codes	Description
200	Query successful.
204	Query successful. Response has no content.
401	Access not authorized. The session must be authorized first.
404	The given resource could not be found.
405	The HTTP method used is not allowed for this query.
500	A server error occurred. The error message is sent with the response. On the ground of security, a detailed error message is not included in the response. For more information, see the application log file on the server.

Related topics

Response formats

Avoiding deadlocks

Basic principles of API development > Guidelines and conventions > Avoiding deadlocks

API development includes a lot of asynchronous code with async/await constructs. To avoid deadlocks, use the ConfigureAwait(false) method for every await keyword.

For more information, see https://blog.stephencleary.com/2012/07/dont-block-on-async-code.html and https://devblogs.microsoft.com/dotnet/configureawait-faq/.

Examples and help – Software Development Kit

Examples and help – Software Development Kit

To make it easier for you to start developing your API, One Identity provides a Software Development Kit (SDK) with lots of commented code example.

The SDK can be found on the installation medium in the directory QBM\dvd\AddOn\ApiSamples.

Implementing your own APIs

Implementing your own APIs

To implement your own APIs, you can create API plugins.

The API Server loads all DLLs matching the *.CompositionApi.Server.PlugIn.dll naming scheme and deploys the API definitions contained therein.

To implement your own APIs, the following options are available:

You can add an API to a One Identity API project (see Adding APIs to One Identity API projects).
You can create your own API project (Creating API projects).
You can add an API to your own existing API projects (see Adding APIs to your own API projects).

Detailed information about this topic

Related Documents

The document was helpful.

Seleziona valutazione

I easily found the information I needed.

Seleziona valutazione

© 2024 One Identity LLC. ALL RIGHTS RESERVED. Termini di utilizzo Privacy Cookie Preference Center