{"id":2926,"date":"2023-03-09T08:46:57","date_gmt":"2023-03-09T08:46:57","guid":{"rendered":"https:\/\/sdf-docs.clevr.com\/?docs=api\/authentication"},"modified":"2023-03-09T09:12:14","modified_gmt":"2023-03-09T09:12:14","slug":"authentication","status":"publish","type":"docs","link":"https:\/\/sdf-docs.clevr.com\/?docs=api\/authentication","title":{"rendered":"Authentication"},"content":{"rendered":"\n<p>Authentication is done in the request JSON by specifying the APIKey and AppID (named ProjectID).<\/p>\n\n\n\n<figure class=\"wp-block-image size-full\"><img loading=\"lazy\" decoding=\"async\" width=\"197\" height=\"110\" src=\"https:\/\/sdf-docs.clevr.com\/wp-content\/uploads\/2023\/03\/image-7.png\" alt=\"\" class=\"wp-image-2928\"\/><\/figure>\n\n\n\n<p><\/p>\n\n\n\n<h1 class=\"wp-block-heading\">The APIKey<\/h1>\n\n\n\n<p>This is the key we use to connect to your specific application in ACR. You create the APIKey under the <em>App Settings<\/em> of the application you want to review in ACR.  Make sure you give it a fitting name, so you know where you are using it. <\/p>\n\n\n\n<p>See <a href=\"https:\/\/sdf-docs.clevr.com\/?docs=acr\/app-settings\/api-key\">here<\/a> for code review APIKey<\/p>\n\n\n\n<p>See <a href=\"https:\/\/sdf-docs.clevr.com\/wp-admin\/post.php?action=edit&amp;post=134\" data-type=\"URL\" data-id=\"https:\/\/sdf-docs.clevr.com\/wp-admin\/post.php?action=edit&amp;post=134\" target=\"_blank\" rel=\"noreferrer noopener\">here<\/a> for CI\/CD APIkey<\/p>\n\n\n\n<p>See <a rel=\"noreferrer noopener\" href=\"https:\/\/sdf-docs.clevr.com\/?docs=ams\/app-settings\/api-keys\" target=\"_blank\">here <\/a>for security APIKey<\/p>\n\n\n\n<p><\/p>\n\n\n\n<h1 class=\"wp-block-heading\">The AppID<\/h1>\n\n\n\n<p>The AppID is the unique code used to identify your application within the Mendix ecosystem. You find the AppID within Mendix Sprintr. Select the application you want to review in the app overview, go to <em>General Settings,<\/em> and there you find the AppID. <\/p>\n\n\n\n<figure class=\"wp-block-image size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" src=\"https:\/\/sdf-docs.clevr.com\/wp-content\/uploads\/2021\/11\/image-2-1024x517.png\" alt=\"\" class=\"wp-image-2299\" width=\"821\" height=\"414\"\/><\/figure>\n\n\n\n<h1 class=\"wp-block-heading\">Usage from CI\/CD<\/h1>\n\n\n\n<h2 class=\"wp-block-heading\">API Account<\/h2>\n\n\n\n<p>An API account is where in our CI\/CD you configure how to login into other apps. So if you are using another CI\/CD tool you do not need API accounts!<\/p>\n\n\n\n<p>If you have created an APIKey you can copy-paste it here into an API account, so a CI\/CD pipeline job can use this API account to &#8216;login&#8217;.<\/p>\n\n\n\n<p>See <a href=\"https:\/\/sdf-docs.clevr.com\/wp-admin\/post.php?action=edit&amp;post=186\" data-type=\"URL\" data-id=\"https:\/\/sdf-docs.clevr.com\/wp-admin\/post.php?action=edit&amp;post=186\">here<\/a> for how to manage API accounts.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Auto check account<\/h2>\n\n\n\n<p>For scheduled and on commit CI\/CD pipelines a Mendix account must be used that has access. Please follow the steps described in <a href=\"https:\/\/sdf-docs.clevr.com\/wp-admin\/post.php?action=edit&amp;post=2567\">App settings<\/a> to ensure a Mendix account is configured, either a special user or a normal user.<\/p>\n","protected":false},"featured_media":0,"parent":2920,"menu_order":1,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-2926","docs","type-docs","status-publish","hentry"],"comment_count":0,"_links":{"self":[{"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/2926"}],"collection":[{"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=2926"}],"version-history":[{"count":3,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/2926\/revisions"}],"predecessor-version":[{"id":2941,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/2926\/revisions\/2941"}],"up":[{"embeddable":true,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/2920"}],"next":[{"title":"Error handling","link":"https:\/\/sdf-docs.clevr.com\/?docs=api\/error-handling","href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/2932"}],"prev":[{"title":"Swagger","link":"https:\/\/sdf-docs.clevr.com\/?docs=api\/swagger","href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=\/wp\/v2\/docs\/2923"}],"wp:attachment":[{"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=2926"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/sdf-docs.clevr.com\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=2926"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}