{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Introduction","type":"text"}]},{"type":"paragraph","content":[{"text":"The API is configured via .NET dependency injection. Depending on the Openld client configuration and desired authentication method, the configuration can look different.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Basic options","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"ApiBaseUri","type":"text"}]},{"type":"paragraph","content":[{"text":"The URL under which the API can be reached, Example: https://localhost:8000/apiv2/latest","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"ExplodeFlatChainProperties","type":"text"}]},{"type":"paragraph","content":[{"text":"Default: true","type":"text"}]},{"type":"paragraph","content":[{"text":"Defines wether property chains are returned as nested objects or simple objects.","type":"text"}]},{"type":"paragraph","content":[{"text":"Example: ","type":"text"},{"text":"/servicedmcore/CoreIdentity/2/?fields=Id,Nachname,CoreIdentityType.Id","type":"text","marks":[{"type":"code"}]}]},{"type":"table","attrs":{"layout":"default","localId":"e25ba109-bd6d-4f08-807d-5a7a7e88ef2a"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"ExplodeFlatChainProperties = true","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"ExplodeFlatChainProperties = false","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"ci_family_name\": {\n \"was_access_denied\": false,\n \"value\": \"Testikus\"\n },\n \"id\": 20,\n \"core_identity_type\": {\n \"id\": {\n \"was_access_denied\": false,\n \"value\": 1\n }\n }\n}","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"ci_family_name\": {\n \"was_access_denied\": false,\n \"value\": \"Testikus\"\n },\n \"core_identity_type.id\": {\n \"was_access_denied\": false,\n \"value\": 1\n },\n \"id\": 20\n}","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"AccessDeniedReplacementString","type":"text"}]},{"type":"paragraph","content":[{"text":"Defines wether the AccessDeniedHandler objects should be replaced. If the option is used, only the value of the value property is returned instead of the AcessDeniedHandler objects. If there is a denial access, the ReplacementString is returned instead of the value.","type":"text"}]},{"type":"paragraph","content":[{"text":"This option is not type-safe, since a string is always returned in the event of an access denial, regardless of the original type of the property.","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Example: ","type":"text"},{"text":"/servicedmcore/CoreIdentity/2/?fields=Id,Nachname,Language","type":"text","marks":[{"type":"code"}]}]},{"type":"table","attrs":{"layout":"default","localId":"9e373274-4401-4c47-9a7c-a2e791f5f283"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"paragraph"}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"AccessDeniedReplacementString=\">Denied<\"","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"ci_family_name\": {\n \"was_access_denied\": true,\n \"value\": null\n },\n \"id\": 20,\n \"core_identity_type\": {\n \"id\": {\n \"was_access_denied\": false,\n \"value\": 1\n }\n }\n}","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[380.0]},"content":[{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"ci_family_name\": \">Denied<\",\n \"id\": 20,\n \"core_identity_type\": {\n \"id\": 1\n }\n}","type":"text"}]},{"type":"paragraph"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":".NET Core configuration","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Required assemblies","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"iTsense.Moving.Common.NetStandard","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"iTsense.Moving.Common.ApiV2","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"iTsense.Moving.Common.ApiV2.Client","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"iTsense.Moving.Common.ApiV2.Client.NetCore","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Optional assemblies","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"iTsense.Moving.Common.ApiV2.Client.DataContracts","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Standard Datacontracts","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example configuration with authentication via HTTP user context","type":"text"}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"public void ConfigureServices(IServiceCollection services)\n{\n\tservices.AddApiV2ClientWithHttpContextAuthentication(o =>\n\t{\n\t\to.ApiBaseUri = new Uri(\"https://localhost:8000/apiv2/latest\");\n\t\t//o.ExplodeFlatChainProperties = false;\n\t\t//o.AccessDeniedReplacementString = \">>AccessDenied<<\";\n\t});\n\tservices.AddOpenIdConnectCookieAuthentication(options =>\n\t{\n\t\toptions.Authority = \"https://coslogin.local:5000\";\n\t\toptions.RequireHttpsMetadata = false; // dev only\n\t\toptions.ClientId = \"[OpenID Client Id]\";\n\t\toptions.ClientSecret = \"[OpenID Client Secret]\";\n\t\toptions.ResponseType = \"code\";\n\t\toptions.ResponseMode = \"form_post\";\n\t\toptions.Scope.Add(\"roles\");\n\t\toptions.Scope.Add(\"profile\");\n\t\toptions.Scope.Add(\"offline_access\");\n\t\toptions.SaveTokens = true;\n\t\toptions.GetClaimsFromUserInfoEndpoint = true;\n\t\toptions.CallbackPath = \"/signin-oidc\";\n\t\toptions.UsePkce = true;\n\t});\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example configuration with authentication via static API user","type":"text"}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"public void ConfigureServices(IServiceCollection services)\n{\n\tservices.AddApiV2ClientWithOpenIdPasswordFlow(o =>\n\t{\n\t\to.Authority = new Uri(\"https://coslogin.local:5000\");\n\t\to.ApiBaseUri = new Uri(\"https://localhost:8000/apiv2/latest\");\n\t\to.ClientId = \"[OpenID Client Id]\";\n\t\to.ClientSecret = \"[OpenID Client Secret]\";\n\t\to.Username = \"[OpenID User Name]\";\n\t\to.Password = \"[OpenID User Password]\";\n\t\t//o.ExplodeFlatChainProperties = false;\n\t\t//o.AccessDeniedReplacementString = \">>AccessDenied<<\";\n\t});\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":".NET Full Framework configuration (Castle Windsor)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Required Assemblies","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"iTsense.Moving.Common.NetStandard","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"iTsense.Moving.Common.ApiV2","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"iTsense.Moving.Common.ApiV2.Client","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"iTsense.Moving.Common.ApiV2.Client.CastleWindsor","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Optional assemblies","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"iTsense.Moving.Common.ApiV2.Client.DataContracts","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Standard Datacontracts","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example configuration with authentication via static API user","type":"text"}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"public void ConfigureContainer(IWindsorContainer container)\n{\n\tcontainer.AddApiV2ClientWithOpenIdPasswordFlow(o =>\n\t{\n\t\to.Authority = new Uri(\"https://coslogin.local:5000\");\n\t\to.ApiBaseUri = new Uri(\"https://localhost:8000/apiv2/latest\");\n\t\to.ClientId = \"[OpenID Client Id]\";\n\t\to.ClientSecret = \"[OpenID Client Secret]\";\n\t\to.Username = \"[OpenID User Name]\";\n\t\to.Password = \"[OpenID User Password]\";\n\t});\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Multiple clients with different coigurations","type":"text"}]},{"type":"paragraph","content":[{"text":"Multiple clients with different configuratins can be registered. To do this, one interface must be declared for each configuration. These can then be consumed via dependency injection.","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"},{"text":"The new interfaces must not contain any additional members!","type":"text","marks":[{"type":"strong"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example configuration","type":"text"}]},{"type":"codeBlock","attrs":{"language":"csharp"},"content":[{"text":"public interface IApiV2ClientUserContext : IApiV2Client\n{\n}\npublic interface IApiV2ClientAdminContext : IApiV2Client\n{\n}\n\npublic class Startup\n{\n\tpublic void ConfigureServices(IServiceCollection services)\n\t{\n\t\tservices.AddApiV2ClientWithHttpContextAuthentication(o =>\n\t\t{\n\t\t\to.ApiBaseUri = new Uri(\"https://localhost:8000/apiv2/latest\");\n\t\t\t//o.ExplodeFlatChainProperties = false;\n\t\t\t//o.AccessDeniedReplacementString = \">>AccessDenied<<\";\n\t\t});\n\t\tservices.AddOpenIdConnectCookieAuthentication(options =>\n\t\t{\n\t\t\toptions.Authority = \"https://coslogin.local:5000\";\n\t\t\toptions.RequireHttpsMetadata = false; // dev only\n\t\t\toptions.ClientId = \"[OpenID Client Id]\";\n\t\t\toptions.ClientSecret = \"[OpenID Client Secret]\";\n\t\t\toptions.ResponseType = \"code\";\n\t\t\toptions.ResponseMode = \"form_post\";\n\t\t\toptions.Scope.Add(\"roles\");\n\t\t\toptions.Scope.Add(\"profile\");\n\t\t\toptions.Scope.Add(\"offline_access\");\n\t\t\toptions.SaveTokens = true;\n\t\t\toptions.GetClaimsFromUserInfoEndpoint = true;\n\t\t\toptions.CallbackPath = \"/signin-oidc\";\n\t\t\toptions.UsePkce = true;\n\t\t});\n\t\tservices.AddApiV2ClientWithOpenIdPasswordFlow(o =>\n\t\t{\n\t\t\to.Authority = new Uri(\"https://coslogin.local:5000\");\n\t\t\to.ApiBaseUri = new Uri(\"https://localhost:8000/apiv2/latest\");\n\t\t\to.ClientId = \"[OpenID Client Id]\";\n\t\t\to.ClientSecret = \"[OpenID Client Secret]\";\n\t\t\to.Username = \"[OpenID User Name]\";\n\t\t\to.Password = \"[OpenID User Password]\";\n\t\t\t//o.ExplodeFlatChainProperties = false;\n\t\t\t//o.AccessDeniedReplacementString = \">>AccessDenied<<\";\n\t\t});\n\t}\n}","type":"text"}]}],"version":1}

Browser not supported