{ "info": { "_postman_id": "e2e37c65-354f-4b67-a01a-fb7ecda45e3c", "name": "Oracle Advanced Authentication REST API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "REST API for Defining System Entities", "item": [ { "name": "agent/v1", "item": [ { "name": "Create a new API integration agent", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentName\": \"APIAgent\",\n \"description\": \"Agent for REST API\",\n \"clientType\": \"API\"\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/agent/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "agent", "v1" ] }, "description": "Create an API Integration Agent.\n\nIn this example an agent called \"APIAgent\" is created of type \"API\"\n\nIn the Example Success Response the following is returned:\n\n\"agentgid\" - this is required for other API operations where the agent id is passed. \n\n\"clientId\" and \"clientSecret\" - the client id and client secret assigned to the agent." }, "response": [ { "name": "Example Success Response - Create a new API integration agent", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentName\": \"APIAgent\",\n \"description\": \"Agent for REST API\",\n \"clientType\": \"API\"\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/agent/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "agent", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 09:06:13 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "569" } ], "cookie": [], "body": "{\n \"status\": \"201\",\n \"message\": \"Successfully created agent.\",\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"agent\": {\n \"agentName\": \"APIAgent\",\n \"description\": \"Agent for REST API\",\n \"clientId\": \"c1e08e6a-b555-47e1-84a5-36edd06fbf57\",\n \"clientSecret\": \"b2484989-5f42-4ad8-b0ab-7bbaa06ee786\",\n \"clientType\": \"api\",\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"createTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:06:13.668Z\",\n \"rawParam\": \"2021-04-01T09:06:13.668Z\"\n },\n \"updateTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:06:13.668Z\",\n \"rawParam\": \"2021-04-01T09:06:13.668Z\"\n }\n }\n}" } ] }, { "name": "Create a new OAM integration agent", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentName\": \"OAM-MFAPartner\",\n \"description\": \"OAA TAP Partner\",\n \"clientType\": \"OAM\",\n \"privateKey\": \"CECECECE000000020000000100000003000C7461706369706865726B657900000177916E17A2ACED000573720033636F6D2E73756E2E63727970746F2E70726F76696465722E5365616C65644F626A656374466F724B657950726F746563746F72CD57CA59E730BB53020000787200196A617661782E63727970746F2E5365616C65644F626A6563743E363DA6C3B754700200045B000D656E636F646564506172616D737400025B425B0010656E63727970746564436F6E74656E7471007E00024C0009706172616D73416C677400124C6A6176612F6C616E672F537472696E673B4C00077365616C416C6771007E00037870757200025B42ACF317F8060854E0020000787000000011300F04085F3CED99EE429B350203030D407571007E00050000009069A8587D9C6671DFEC9A48E18A45BBC106F8518EBB1AC2A7B94CC779C5AD0D3F52863FE6D13E02EFFB60EDDB47FB229D5CD0A6E2312A9467F88F355AE504DDA4C632CA9CB6CBCE7A9C001FD7B7F7FD5505221FBC39968E262B717094E940D817EEBAB14F38865CFCBB12BA0CD8DDB06DA738F6776111DDDBE8ECD25EE59A274CCAFE06BBBB5535E8DAD9648C08EDA6AA740016504245576974684D4435416E64547269706C65444553740016504245576974684D4435416E64547269706C654445531A355132C5E0EBBEF4022030F940DC8495DEA491\",\n \"privateKeyFile\": \"OAMOAAKeyStore.jks\",\n \"privateKeyPassword\": \"\"\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/agent/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "agent", "v1" ] }, "description": "Create a new OAM Integration Agent.\n\nIn this example an agent called \"OAM-MFAPartner\" is created of clientType \"OAM\"\n\n\"privateKey\" - is the hex value of the key generated when registering the TAP Partner in OAM using the \"registerThirdPartyTAPPartner\" command.\n\nTo convert the TAP key to hex use the following Linux command: \n\nxxd -plain -u .jks | tr -d ‘\\n’\n\n\"privateKeyFile\" - is the name of the key file that was generated when registering the TAP Partner in OAM using the \"registerThirdPartyTAPPartner\" command.\n\n\"privateKeyPassword\" - is the password used when registering the TAP Partner in OAM using the \"registerThirdPartyTAPPartner\" command.\n\nIn the Example Success Response the following is returned:\n\n\"agentgid\" - this is required for other API operations where the agent id is passed.\n\n\"clientId\" and \"clientSecret\" - the client id and client secret assigned to the agent." }, "response": [ { "name": "Example Success Response - Create a new OAM integration agent", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentName\": \"OAM-MFAPartner\",\n \"description\": \"OAA TAP Partner\",\n \"clientType\": \"OAM\",\n \"privateKey\": \"CECECECE000000020000000100000003000C7461706369706865726B657900000177916E17A2ACED000573720033636F6D2E73756E2E63727970746F2E70726F76696465722E5365616C65644F626A656374466F724B657950726F746563746F72CD57CA59E730BB53020000787200196A617661782E63727970746F2E5365616C65644F626A6563743E363DA6C3B754700200045B000D656E636F646564506172616D737400025B425B0010656E63727970746564436F6E74656E7471007E00024C0009706172616D73416C677400124C6A6176612F6C616E672F537472696E673B4C00077365616C416C6771007E00037870757200025B42ACF317F8060854E0020000787000000011300F04085F3CED99EE429B350203030D407571007E00050000009069A8587D9C6671DFEC9A48E18A45BBC106F8518EBB1AC2A7B94CC779C5AD0D3F52863FE6D13E02EFFB60EDDB47FB229D5CD0A6E2312A9467F88F355AE504DDA4C632CA9CB6CBCE7A9C001FD7B7F7FD5505221FBC39968E262B717094E940D817EEBAB14F38865CFCBB12BA0CD8DDB06DA738F6776111DDDBE8ECD25EE59A274CCAFE06BBBB5535E8DAD9648C08EDA6AA740016504245576974684D4435416E64547269706C65444553740016504245576974684D4435416E64547269706C654445531A355132C5E0EBBEF4022030F940DC8495DEA491\",\n \"privateKeyFile\": \"OAMOAAKeyStore.jks\",\n \"privateKeyPassword\": \"\"\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/agent/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "agent", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 09:13:13 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "1673" } ], "cookie": [], "body": "{\n \"status\": \"201\",\n \"message\": \"Successfully created agent.\",\n \"agentgid\": \"58a4bc7f-073b-4fca-9eee-ed0882e4d293\",\n \"agent\": {\n \"agentName\": \"OAM-MFAPartner\",\n \"description\": \"OAA TAP Partner\",\n \"clientId\": \"12e80604-1ae4-43d9-8839-170ae5534274\",\n \"clientSecret\": \"ce8cb5d5-642b-4338-a267-19feb344fbfd\",\n \"clientType\": \"oam\",\n \"agentgid\": \"58a4bc7f-073b-4fca-9eee-ed0882e4d293\",\n \"privateKey\": \"CECECECE000000020000000100000003000C7461706369706865726B657900000177916E17A2ACED000573720033636F6D2E73756E2E63727970746F2E70726F76696465722E5365616C65644F626A656374466F724B657950726F746563746F72CD57CA59E730BB53020000787200196A617661782E63727970746F2E5365616C65644F626A6563743E363DA6C3B754700200045B000D656E636F646564506172616D737400025B425B0010656E63727970746564436F6E74656E7471007E00024C0009706172616D73416C677400124C6A6176612F6C616E672F537472696E673B4C00077365616C416C6771007E00037870757200025B42ACF317F8060854E0020000787000000011300F04085F3CED99EE429B350203030D407571007E00050000009069A8587D9C6671DFEC9A48E18A45BBC106F8518EBB1AC2A7B94CC779C5AD0D3F52863FE6D13E02EFFB60EDDB47FB229D5CD0A6E2312A9467F88F355AE504DDA4C632CA9CB6CBCE7A9C001FD7B7F7FD5505221FBC39968E262B717094E940D817EEBAB14F38865CFCBB12BA0CD8DDB06DA738F6776111DDDBE8ECD25EE59A274CCAFE06BBBB5535E8DAD9648C08EDA6AA740016504245576974684D4435416E64547269706C65444553740016504245576974684D4435416E64547269706C654445531A355132C5E0EBBEF4022030F940DC8495DEA491\",\n \"privateKeyPassword\": \"\",\n \"privateKeyFile\": \"OAMOAAKeyStore.jks\",\n \"createTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:13:13.391Z\",\n \"rawParam\": \"2021-04-01T09:13:13.391Z\"\n },\n \"updateTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:13:13.392Z\",\n \"rawParam\": \"2021-04-01T09:13:13.392Z\"\n }\n }\n}" } ] }, { "name": "Create a new Oracle RADIUS integration agent", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentName\": \"RadiusAgent\",\n \"description\": \"Radius Agent\",\n \"clientType\": \"Radius\"\n \n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/agent/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "agent", "v1" ] }, "description": "Create an Oracle Radius Integration Agent.\n\nIn this example an agent called \"RadiusAgent\" is created of type \"Radius\"\n\nIn the Example Success Response the following is returned:\n\n\"agentgid\" - this is required for other API operations where the agent id is passed.\n\n\"clientId\" and \"clientSecret\" - the client id and client secret assigned to the agent." }, "response": [ { "name": "Example Success Response - Create a new Oracle Radius integration agent", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentName\": \"RadiusAgent\",\n \"description\": \"Radius Agent\",\n \"clientType\": \"Radius\"\n \n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/agent/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "agent", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 09:14:34 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "569" } ], "cookie": [], "body": "{\n \"status\": \"201\",\n \"message\": \"Successfully created agent.\",\n \"agentgid\": \"e53bc397-b17b-4765-822c-e1e7f24ac14f\",\n \"agent\": {\n \"agentName\": \"RadiusAgent\",\n \"description\": \"Radius Agent\",\n \"clientId\": \"3d3f3800-e801-4e26-9930-1f5a9021eb38\",\n \"clientSecret\": \"0ef31e1f-4123-40bc-8df7-79810116af54\",\n \"clientType\": \"radius\",\n \"agentgid\": \"e53bc397-b17b-4765-822c-e1e7f24ac14f\",\n \"createTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:14:34.833Z\",\n \"rawParam\": \"2021-04-01T09:14:34.833Z\"\n },\n \"updateTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:14:34.833Z\",\n \"rawParam\": \"2021-04-01T09:14:34.833Z\"\n }\n }\n}" } ] }, { "name": "Return all integration agents from the store", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/agent/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "agent", "v1" ] }, "description": "Return all integration agents and their details from the store." }, "response": [ { "name": "Example Success Response - Return all agents from the store", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/agent/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "agent", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 09:15:04 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "6632" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Successful\",\n \"agents\": [\n {\n \"agentName\": \"APIAgent\",\n \"description\": \"Agent for REST API\",\n \"clientId\": \"c1e08e6a-b555-47e1-84a5-36edd06fbf57\",\n \"clientSecret\": \"b2484989-5f42-4ad8-b0ab-7bbaa06ee786\",\n \"clientType\": \"api\",\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"createTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:06:13.668Z\",\n \"rawParam\": \"2021-04-01T09:06:13.668Z\"\n },\n \"updateTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:06:13.668Z\",\n \"rawParam\": \"2021-04-01T09:06:13.668Z\"\n }\n },\n {\n \"agentName\": \"RadiusAgent\",\n \"description\": \"Radius Agent\",\n \"clientId\": \"3d3f3800-e801-4e26-9930-1f5a9021eb38\",\n \"clientSecret\": \"0ef31e1f-4123-40bc-8df7-79810116af54\",\n \"clientType\": \"radius\",\n \"agentgid\": \"e53bc397-b17b-4765-822c-e1e7f24ac14f\",\n \"createTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:14:34.833Z\",\n \"rawParam\": \"2021-04-01T09:14:34.833Z\"\n },\n \"updateTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:14:34.833Z\",\n \"rawParam\": \"2021-04-01T09:14:34.833Z\"\n }\n },\n {\n \"agentName\": \"OAM-MFAPartner\",\n \"description\": \"OAA TAP Partner\",\n \"clientId\": \"12e80604-1ae4-43d9-8839-170ae5534274\",\n \"clientSecret\": \"ce8cb5d5-642b-4338-a267-19feb344fbfd\",\n \"clientType\": \"oam\",\n \"agentgid\": \"58a4bc7f-073b-4fca-9eee-ed0882e4d293\",\n \"privateKey\": \"CECECECE000000020000000100000003000C7461706369706865726B657900000177916E17A2ACED000573720033636F6D2E73756E2E63727970746F2E70726F76696465722E5365616C65644F626A656374466F724B657950726F746563746F72CD57CA59E730BB53020000787200196A617661782E63727970746F2E5365616C65644F626A6563743E363DA6C3B754700200045B000D656E636F646564506172616D737400025B425B0010656E63727970746564436F6E74656E7471007E00024C0009706172616D73416C677400124C6A6176612F6C616E672F537472696E673B4C00077365616C416C6771007E00037870757200025B42ACF317F8060854E0020000787000000011300F04085F3CED99EE429B350203030D407571007E00050000009069A8587D9C6671DFEC9A48E18A45BBC106F8518EBB1AC2A7B94CC779C5AD0D3F52863FE6D13E02EFFB60EDDB47FB229D5CD0A6E2312A9467F88F355AE504DDA4C632CA9CB6CBCE7A9C001FD7B7F7FD5505221FBC39968E262B717094E940D817EEBAB14F38865CFCBB12BA0CD8DDB06DA738F6776111DDDBE8ECD25EE59A274CCAFE06BBBB5535E8DAD9648C08EDA6AA740016504245576974684D4435416E64547269706C65444553740016504245576974684D4435416E64547269706C654445531A355132C5E0EBBEF4022030F940DC8495DEA491\",\n \"privateKeyPassword\": \"Welcome1\",\n \"privateKeyFile\": \"OAMOAAKeyStore.jks\",\n \"createTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:13:13.391Z\",\n \"rawParam\": \"2021-04-01T09:13:13.391Z\"\n },\n \"updateTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:13:13.392Z\",\n \"rawParam\": \"2021-04-01T09:13:13.392Z\"\n }\n }\n ]\n}" } ] }, { "name": "Return integration agent from the store", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/agent/v1/:agentgid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "agent", "v1", ":agentgid" ], "variable": [ { "key": "agentgid", "value": "dede64d3-1d6a-42e9-89e1-714e88f8967c" } ] }, "description": "Return details of an integration agent from the store based on the \"agentgid\".\n\nIn the Params tab enter the value for the \"agentgid\" that you want to return." }, "response": [ { "name": "Example Success Response - Return integration agent from the store", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/agent/v1/:agentgid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "agent", "v1", ":agentgid" ], "variable": [ { "key": "agentgid", "value": "dede64d3-1d6a-42e9-89e1-714e88f8967c" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 09:10:57 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "552" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Successful\",\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"agent\": {\n \"agentName\": \"APIAgent\",\n \"description\": \"Agent for REST API\",\n \"clientId\": \"c1e08e6a-b555-47e1-84a5-36edd06fbf57\",\n \"clientSecret\": \"b2484989-5f42-4ad8-b0ab-7bbaa06ee786\",\n \"clientType\": \"api\",\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"createTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:06:13.668Z\",\n \"rawParam\": \"2021-04-01T09:06:13.668Z\"\n },\n \"updateTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:06:13.668Z\",\n \"rawParam\": \"2021-04-01T09:06:13.668Z\"\n }\n }\n}" } ] }, { "name": "Update an existing integration agent", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentName\": \"APIAgent\",\n \"description\": \"API Agent Update\"\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/agent/v1/:agentgid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "agent", "v1", ":agentgid" ], "variable": [ { "key": "agentgid", "value": "dede64d3-1d6a-42e9-89e1-714e88f8967c" } ] }, "description": "Update an integration agent.\n\nIn the Params tab enter the value for the \"agentgid\" of the agent that you wish to update.\n\nIn the Body modify the values you wish to update.\n\nIn this example the \"description\" field has been updated for the agent \"APIAgent\"." }, "response": [ { "name": "Example Success Response - Update an existing integration agent", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentName\": \"APIAgent\",\n \"description\": \"API Agent Update\"\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/agent/v1/:agentgid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "agent", "v1", ":agentgid" ], "variable": [ { "key": "agentgid", "value": "dede64d3-1d6a-42e9-89e1-714e88f8967c" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 09:18:36 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "558" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Update Successful.\",\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"agent\": {\n \"agentName\": \"APIAgent\",\n \"description\": \"API Agent Update\",\n \"clientId\": \"c1e08e6a-b555-47e1-84a5-36edd06fbf57\",\n \"clientSecret\": \"b2484989-5f42-4ad8-b0ab-7bbaa06ee786\",\n \"clientType\": \"api\",\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"createTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:06:13.668Z\",\n \"rawParam\": \"2021-04-01T09:06:13.668Z\"\n },\n \"updateTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:18:36.142Z\",\n \"rawParam\": \"2021-04-01T09:18:36.142Z\"\n }\n }\n}" } ] }, { "name": "Remove an integration agent", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/agent/v1/:agentgid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "agent", "v1", ":agentgid" ], "variable": [ { "key": "agentgid", "value": "ed022f31-c5f5-4665-8a19-159655f514ae" } ] }, "description": "Delete an integration agent.\n\nIn the Params tab enter the value of the \"agentgid\" of the agent you wish to delete." }, "response": [ { "name": "Example Success Response - Remove an integration agent", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/agent/v1/:agentgid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "agent", "v1", ":agentgid" ], "variable": [ { "key": "agentgid", "value": "ed022f31-c5f5-4665-8a19-159655f514ae" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 09:19:38 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "552" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Agent deleted\",\n \"agentgid\": \"ed022f31-c5f5-4665-8a19-159655f514ae\",\n \"agent\": {\n \"agentName\": \"APIAgent2\",\n \"description\": \"Agent for REST API\",\n \"clientId\": \"0a47d442-9dc0-4841-b734-8e15e1634ee4\",\n \"clientSecret\": \"273a8d9c-29ad-4956-bc8d-69ffcfbf1d73\",\n \"clientType\": \"api\",\n \"agentgid\": \"ed022f31-c5f5-4665-8a19-159655f514ae\",\n \"createTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:19:23.28Z\",\n \"rawParam\": \"2021-04-01T09:19:23.28Z\"\n },\n \"updateTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T09:19:23.28Z\",\n \"rawParam\": \"2021-04-01T09:19:23.28Z\"\n }\n }\n}" } ] } ], "description": "Use this collection to create, update, fetch, and delete agents in Oracle Advanced Authentication." }, { "name": "assuranceLevel/v1", "item": [ { "name": "{id}", "item": [ { "name": "Define Assurance Level", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"AssuranceLevel1\",\n \"name\": \"AssuranceLevel1\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"description\": \"Assurance Level 1\"\n \n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/assuranceLevel/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "assuranceLevel", "v1" ] }, "description": "Create an assurance level and assign it to an integration agent.\n\nIn this example an assurance level called \"AssuranceLevel1\" is created and assigned to the \"agentgid\" that corresponds to the \"APIAgent\".\n\nWhilst \"id\" and \"name\" can be different, it's recommended to keep them the same for ease of use." }, "response": [ { "name": "Example Success Response - Define Assurance Level", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"AssuranceLevel1\",\n \"name\": \"AssuranceLevel1\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"description\": \"Assurance Level 1\"\n \n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/assuranceLevel/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "assuranceLevel", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 09:09:21 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "245" } ], "cookie": [], "body": "{\n \"assuranceLevels\": [\n {\n \"id\": \"AssuranceLevel1\",\n \"name\": \"AssuranceLevel1\",\n \"description\": \"Assurance Level 1\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\"\n }\n ],\n \"message\": {\n \"responseCode\": \"201\",\n \"responseMessage\": \"Assurance level created successfully.\"\n }\n}" } ] }, { "name": "Get assurance level from the store", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/assuranceLevel/v1/:id", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "assuranceLevel", "v1", ":id" ], "variable": [ { "key": "id", "value": "AssuranceLevel1" } ] }, "description": "Get the assurance level details from the store.\n\nIn the Params tab update the value for \"assurancelevel\" with the name of the assurance level to fetch." }, "response": [ { "name": "Example Success Response - Get assurance level from the store", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/assuranceLevel/v1/:id", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "assuranceLevel", "v1", ":id" ], "variable": [ { "key": "id", "value": "AssuranceLevel1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 09:22:31 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "236" } ], "cookie": [], "body": "{\n \"assuranceLevels\": [\n {\n \"id\": \"AssuranceLevel1\",\n \"name\": \"AssuranceLevel1\",\n \"description\": \"Assurance Level 1\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\"\n }\n ],\n \"message\": {\n \"responseCode\": \"200\",\n \"responseMessage\": \"Assurance level information.\"\n }\n}" } ] }, { "name": "Get all assurance levels that belongs to an integration agent", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/assuranceLevel/v1?agentid=dede64d3-1d6a-42e9-89e1-714e88f8967c", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "assuranceLevel", "v1" ], "query": [ { "key": "agentid", "value": "dede64d3-1d6a-42e9-89e1-714e88f8967c", "description": "(Required) Global identifier of the agent which control the checkpoints. Agent global identifer is required parameter." } ] }, "description": "Get all assurance levels assigned to an integration agent.\n\nIn the Params tab enter the value of the \"agentgid\" for the agent that you want to retrieve assurance levels for." }, "response": [ { "name": "Example Success Response - Get all assurance levels that belongs to an integration agent", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/assuranceLevel/v1?agentid=dede64d3-1d6a-42e9-89e1-714e88f8967c", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "assuranceLevel", "v1" ], "query": [ { "key": "agentid", "value": "dede64d3-1d6a-42e9-89e1-714e88f8967c", "description": "(Required) Global identifier of the agent which control the checkpoints. Agent global identifer is required parameter." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 09:23:26 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "236" } ], "cookie": [], "body": "{\n \"assuranceLevels\": [\n {\n \"id\": \"AssuranceLevel1\",\n \"name\": \"AssuranceLevel1\",\n \"description\": \"Assurance Level 1\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\"\n }\n ],\n \"message\": {\n \"responseCode\": \"200\",\n \"responseMessage\": \"Assurance level information.\"\n }\n}" } ] }, { "name": "Update existing assurance level", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"AssuranceLevel1\",\n \"name\": \"AssuranceLevel1\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"description\": \"Update to Assurance Level 1\"\n \n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/assuranceLevel/v1/:id", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "assuranceLevel", "v1", ":id" ], "variable": [ { "key": "id", "value": "AssuranceLevel1" } ] }, "description": "Update an assurance level assigned to an integration agent.\n\nIn this example the \"description\" for \"AssuranceLevel1\" is updated for the \"agentgid\" associated with the \"AgentAPI\"" }, "response": [ { "name": "Example Success Response - Update existing assurance level", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"AssuranceLevel1\",\n \"name\": \"AssuranceLevel1\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"description\": \"Update to Assurance Level 1\"\n \n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/assuranceLevel/v1/:id", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "assuranceLevel", "v1", ":id" ], "variable": [ { "key": "id", "value": "AssuranceLevel1" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 09:24:12 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "242" } ], "cookie": [], "body": "{\n \"assuranceLevels\": [\n {\n \"id\": \"AssuranceLevel1\",\n \"name\": \"AssuranceLevel1\",\n \"description\": \"Update to Assurance Level 1\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\"\n }\n ],\n \"message\": {\n \"responseCode\": \"200\",\n \"responseMessage\": \"Assurance level updated.\"\n }\n}" } ] }, { "name": "Remove assurance level definition from the system", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/assuranceLevel/v1/:id", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "assuranceLevel", "v1", ":id" ], "variable": [ { "key": "id", "value": "AssuranceLevel2" } ] }, "description": "Delete an assurance level.\n\nIn the Params tab update the value for \"assurancelevel\" with the name of the assurance level to delete." }, "response": [ { "name": "Example Success Response - Remove assurance level definition from the system", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/assuranceLevel/v1/:id", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "assuranceLevel", "v1", ":id" ], "variable": [ { "key": "id", "value": "AssuranceLevel2" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 09:26:08 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "232" } ], "cookie": [], "body": "{\n \"assuranceLevels\": [\n {\n \"id\": \"AssuranceLevel2\",\n \"name\": \"AssuranceLevel2\",\n \"description\": \"Assurance Level 2\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\"\n }\n ],\n \"message\": {\n \"responseCode\": \"200\",\n \"responseMessage\": \"Assurance level deleted.\"\n }\n}" } ] } ] } ], "description": "Use this collection to create, update, fetch and delete Assurance Levels." }, { "name": "group/v1", "item": [ { "name": "{groupid}", "item": [ { "name": "Create new factor group", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"Actions\",\n \"groupname\": \"FactorRuleGrp1\",\n \"description\": \"Group to set factors\",\n \"values\": [\n \"ChallengeEmail\",\n \"ChallengeSMS\"\n ]\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1" ] }, "description": "Create a new factor Group.\n\nIn this example a new group \"FactorRuleGrp1\" is created for a specific \"agentgid\".\n\n\"groupType\" : \"Actions\" creates a group of actions that will later be associated with a policy rule. In this case it sets the factors to \"ChallengeSMS\" and \"ChallengeEmail\".\n\nIn the response the \"groupid\" is returned. The is used in other API requests where \"groupid\" is required, for example when assigning a group to a policy rule in \"Define a new rule for the policy\"." }, "response": [ { "name": "Example Success Response - Create new factor group", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"Actions\",\n \"groupname\": \"FactorRuleGrp1\",\n \"description\": \"Group to set factors\",\n \"values\": [\n \"ChallengeEmail\",\n \"ChallengeSMS\"\n ]\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 09:33:59 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "407" } ], "cookie": [], "body": "{\n \"status\": \"201\",\n \"message\": \"Group created successfully\",\n \"groupid\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"group\": {\n \"groupid\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"Actions\",\n \"groupname\": \"FactorRuleGrp1\",\n \"description\": \"Group to set factors\",\n \"values\": [\n \"ChallengeEmail\",\n \"ChallengeSMS\"\n ]\n }\n}" } ] }, { "name": "Create new group of type User ID", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"User ID\",\n \"groupname\": \"ManagersGroup\",\n \"description\": \"Group for Managers\",\n \"values\": [\n \"manager1\",\n \"manager2\",\n \"manager3\"\n ]\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1" ] }, "description": "Create a new Group of grouptype \"User ID\".\n\nIn this example a new group \"ManagersGroup\" is created for a specific \"agentgid\".\n\n\"grouptype\" : \"User ID\" creates a group containing User ID's that will later be associated with a policy rule. In this case it creates a group with userid's manager1 - manager3\".\n\nIn the response the \"groupid\" is returned. The is used in other API requests where \"groupid\" is required, for example when assigning a group to a policy rule in \"Define a new rule for the policy\"." }, "response": [ { "name": "Example Success Response - Create new group of type User ID", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"User ID\",\n \"groupname\": \"ManagersGroup\",\n \"description\": \"Group for Managers\",\n \"values\": [\n \"manager1\",\n \"manager2\",\n \"manager3\"\n ]\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 09:35:46 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "405" } ], "cookie": [], "body": "{\n \"status\": \"201\",\n \"message\": \"Group created successfully\",\n \"groupid\": \"112_90ba74290eae2b025f4d3edfffc52a89a5b00bfeeb7b9b3b492cf84b4f828390\",\n \"group\": {\n \"groupid\": \"112_90ba74290eae2b025f4d3edfffc52a89a5b00bfeeb7b9b3b492cf84b4f828390\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"User ID\",\n \"groupname\": \"ManagersGroup\",\n \"description\": \"Group for Managers\",\n \"values\": [\n \"manager1\",\n \"manager2\",\n \"manager3\"\n ]\n }\n}" } ] }, { "name": "Create new group of type IP Ranges", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"IP Ranges\",\n \"groupname\": \"Secure IP Range\",\n \"description\": \"Group for Secure IP Range\",\n \"values\": [\n {\n \"name\": \"Secure IP List\",\n \"description\": \"Secure IP Range list\",\n \"from\": \"198.51.100.1\",\n \"to\": \"198.51.100.25\"\n }\n ]\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1" ] }, "description": "Create a new Group of grouptype \"IP Ranges\".\n\nIn this example a new group \"Secure IP Range\" is created for a specific \"agentgid\".\n\n\"grouptype\" : \"IP Ranges\" creates a group containing IP ranges that will later be associated with a policy rule.\n\nIn the response the \"groupid\" is returned. The is used in other API requests where \"groupid\" is required, for example when assigning a group to a policy rule in \"Define a new rule for the policy\"." }, "response": [ { "name": "Example Success Response - Create new group of type IP Ranges", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"IP Ranges\",\n \"groupname\": \"Secure IP Range\",\n \"description\": \"Group for Secure IP Range\",\n \"values\": [\n {\n \"name\": \"Secure IP List\",\n \"description\": \"Secure IP Range list\",\n \"from\": \"198.51.100.1\",\n \"to\": \"198.51.100.25\"\n }\n ]\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 10:34:01 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "489" } ], "cookie": [], "body": "{\n \"status\": \"201\",\n \"message\": \"Group created successfully\",\n \"groupid\": \"127_ddd32e7186d66b2cb96cc4608ded0bb7d6ae4a48b1fc1894c69e715cf262e7ad\",\n \"group\": {\n \"groupid\": \"127_ddd32e7186d66b2cb96cc4608ded0bb7d6ae4a48b1fc1894c69e715cf262e7ad\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"IP Ranges\",\n \"groupname\": \"Secure IP Range\",\n \"description\": \"Group for Secure IP Range\",\n \"values\": [\n {\n \"name\": \"Secure IP List\",\n \"description\": \"Secure IP Range list\",\n \"from\": \"198.51.100.1\",\n \"to\": \"198.51.100.25\"\n }\n ]\n }\n}" } ] }, { "name": "Create new group of type IPs", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"IPs\",\n \"groupname\": \"SecureIP\",\n \"description\": \"Group for Secure IP addresses\",\n \"values\": [\n \"198.51.100.1\",\n \"198.51.100.2\",\n \"198.51.100.3\"\n ]\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1" ] }, "description": "Create a new Group of grouptype \"IPs\".\n\nIn this example a new group \"SecureIP\" is created for a specific \"agentgid\".\n\n\"grouptype\" : \"IPs\" creates a group containing individual IP addresses that will later be associated with a policy rule. In this case it creates a group containing 3 IP addresses.\n\nIn the response the \"groupid\" is returned. The is used in other API requests where \"groupid\" is required, for example when assigning a group to a policy rule in \"Define a new rule for the policy\"." }, "response": [ { "name": "Example Success Response - Create new group of type IPs", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"IPs\",\n \"groupname\": \"SecureIP\",\n \"description\": \"Group for Secure IP addresses\",\n \"values\": [\n \"198.51.100.1\",\n \"198.51.100.2\",\n \"198.51.100.3\"\n ]\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 10:26:31 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "419" } ], "cookie": [], "body": "{\n \"status\": \"201\",\n \"message\": \"Group created successfully\",\n \"groupid\": \"113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b\",\n \"group\": {\n \"groupid\": \"113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"IPs\",\n \"groupname\": \"SecureIP\",\n \"description\": \"Group for Secure IP addresses\",\n \"values\": [\n \"198.51.100.1\",\n \"198.51.100.2\",\n \"198.51.100.3\"\n ]\n }\n}" } ] }, { "name": "Create new group of type Generic Strings", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"Generic Strings\",\n \"groupname\": \"Group for Generic Strings\",\n \"description\": \"Group description for Generic Strings\",\n \"values\": [\n \"some string\",\n \"some other string\"\n ]\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1" ] }, "description": "Create a new Group of grouptype \"Generic Strings\".\n\nIn this example a new group \"Generic Strings\" is created for a specific \"agentgid\".\n\n\"grouptype\" : \"Generic Strings\" creates a group containing individual strings that can later be associated with a policy rule.\n\nIn the response the \"groupid\" is returned. The is used in other API requests where \"groupid\" is required, for example when assigning a group to a policy rule in \"Define a new rule for the policy\"." }, "response": [ { "name": "Example Success Response - Create new group of type Generic Strings", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"Generic Strings\",\n \"groupname\": \"Group for Generic Strings\",\n \"description\": \"Group description for Generic Strings\",\n \"values\": [\n \"some string\",\n \"some other string\"\n ]\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 10:29:53 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "445" } ], "cookie": [], "body": "{\n \"status\": \"201\",\n \"message\": \"Group created successfully\",\n \"groupid\": \"114_7ee5f98740225f1379e86f21d2b0c6b592a236b57e0579e9617bfe4cf0edee5d\",\n \"group\": {\n \"groupid\": \"114_7ee5f98740225f1379e86f21d2b0c6b592a236b57e0579e9617bfe4cf0edee5d\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"Generic Strings\",\n \"groupname\": \"Group for Generic Strings\",\n \"description\": \"Group description for Generic Strings\",\n \"values\": [\n \"some string\",\n \"some other string\"\n ]\n }\n}" } ] }, { "name": "Fetch the group identified by groupid", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1/:groupid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1", ":groupid" ], "variable": [ { "key": "groupid", "value": "111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718" } ] }, "description": "Fetch the group details identified by \"groupid\".\n\nIn the Params tab enter the value of the \"groupid\" for the group to fetch." }, "response": [ { "name": "Example Success Response - Fetch the group identified by groupid", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1/:groupid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1", ":groupid" ], "variable": [ { "key": "groupid", "value": "111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 10:34:48 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "398" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Group information\",\n \"groupid\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"group\": {\n \"groupid\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"Actions\",\n \"groupname\": \"FactorRuleGrp1\",\n \"description\": \"Group to set factors\",\n \"values\": [\n \"ChallengeEmail\",\n \"ChallengeSMS\"\n ]\n }\n}" } ] }, { "name": "Get all groups for the integration agent", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1?agentid=dede64d3-1d6a-42e9-89e1-714e88f8967c", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1" ], "query": [ { "key": "agentid", "value": "dede64d3-1d6a-42e9-89e1-714e88f8967c", "description": "(Required) " } ] }, "description": "Get all groups for the integration agent based on \"agentid\".\n\nIn the Params tab enter the value for the \"agentid\" to return groups for." }, "response": [ { "name": "Example Success Response - Get all groups for the agent", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1?agentid=dede64d3-1d6a-42e9-89e1-714e88f8967c", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1" ], "query": [ { "key": "agentid", "value": "dede64d3-1d6a-42e9-89e1-714e88f8967c", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 10:36:38 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "1503" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Groups information\",\n \"groups\": [\n {\n \"groupid\": \"112_90ba74290eae2b025f4d3edfffc52a89a5b00bfeeb7b9b3b492cf84b4f828390\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"User ID\",\n \"groupname\": \"ManagersGroup\",\n \"description\": \"Group for Managers\",\n \"values\": [\n \"manager1\",\n \"manager2\",\n \"manager3\"\n ]\n },\n {\n \"groupid\": \"114_7ee5f98740225f1379e86f21d2b0c6b592a236b57e0579e9617bfe4cf0edee5d\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"Generic Strings\",\n \"groupname\": \"Group for Generic Strings\",\n \"description\": \"Group description for Generic Strings\",\n \"values\": [\n \"some string\",\n \"some other string\"\n ]\n },\n {\n \"groupid\": \"127_ddd32e7186d66b2cb96cc4608ded0bb7d6ae4a48b1fc1894c69e715cf262e7ad\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"IP Ranges\",\n \"groupname\": \"Secure IP Range\",\n \"description\": \"Group for Secure IP Range\",\n \"values\": [\n {\n \"name\": \"Secure IP List\",\n \"description\": \"Secure IP Range list\",\n \"from\": \"198.51.100.1\",\n \"to\": \"198.51.100.25\"\n }\n ]\n },\n {\n \"groupid\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"Actions\",\n \"groupname\": \"FactorRuleGrp1\",\n \"description\": \"Group to set factors\",\n \"values\": [\n \"ChallengeEmail\",\n \"ChallengeSMS\"\n ]\n },\n {\n \"groupid\": \"113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"IPs\",\n \"groupname\": \"SecureIP\",\n \"description\": \"Group for Secure IP addresses\",\n \"values\": [\n \"198.51.100.1\",\n \"198.51.100.2\",\n \"198.51.100.3\"\n ]\n }\n ]\n}" } ] }, { "name": "Update exisiting group identified by group id", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"groupname\": \"FactorRuleGrp1\",\n \"description\": \"Group to set factors\",\n \"addvalues\": [\n \"ChallengeOMATOTP\",\n \"ChallengeYubicoOTP\"\n ],\n \"removevalues\": [\n \"ChallengeSMS\"\n ]\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1/:groupid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1", ":groupid" ], "variable": [ { "key": "groupid", "value": "111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718" } ] }, "description": "Update existing group identified by groupId.\n\nIn the Params set the value to the \"groupId\" of the group to update.\n\nIn the body:\n\n\"addvalues\" - lists the values to add\n\"removevalues\" - lists the values to remove\n\nIn this example the factors \"ChallengeOMATOTP\" and \"ChallengeYubicoOTP\" are added to the group and \"ChallengeSMS\" is removed." }, "response": [ { "name": "Example Success Response - Update exisiting group identified by group id", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"groupname\": \"FactorRuleGrp1\",\n \"description\": \"Group to set factors\",\n \"addvalues\": [\n \"ChallengeOMATOTP\",\n \"ChallengeYubicoOTP\"\n ],\n \"removevalues\": [\n \"ChallengeSMS\"\n ]\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1/:groupid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1", ":groupid" ], "variable": [ { "key": "groupid", "value": "111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 10:58:20 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "419" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Group updated\",\n \"groupid\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"group\": {\n \"groupid\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"Actions\",\n \"groupname\": \"FactorRuleGrp1\",\n \"description\": \"Group to set factors\",\n \"values\": [\n \"ChallengeEmail\",\n \"ChallengeOMATOTP\",\n \"ChallengeYubicoOTP\"\n ]\n }\n}" } ] }, { "name": "Delete exisiting group identified by group id", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1/:groupid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1", ":groupid" ], "variable": [ { "key": "groupid", "value": "140_b6b25bc75ffae259297e85b5b0a82483bc4e806dd8c7e278a00a134a0474a608" } ] }, "description": "Delete existing group identified by \"groupId\".\n\nIn the Params tab enter the value for the \"groupid\" of the group to delete." }, "response": [ { "name": "Example Success Response - Delete exisiting group identified by group id", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/group/v1/:groupid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "group", "v1", ":groupid" ], "variable": [ { "key": "groupid", "value": "140_b6b25bc75ffae259297e85b5b0a82483bc4e806dd8c7e278a00a134a0474a608" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 11:03:41 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "351" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Group deleted\",\n \"groupid\": \"140_b6b25bc75ffae259297e85b5b0a82483bc4e806dd8c7e278a00a134a0474a608\",\n \"group\": {\n \"groupid\": \"140_b6b25bc75ffae259297e85b5b0a82483bc4e806dd8c7e278a00a134a0474a608\",\n \"agentid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"grouptype\": \"Actions\",\n \"groupname\": \"FactorRuleGrp2\",\n \"description\": \"Group to set factors\"\n }\n}" } ] } ] } ], "description": "Use this collection to create, update, fetch and delete Groups." }, { "name": "policy/v1", "item": [ { "name": "{policygid}", "item": [ { "name": "rule", "item": [ { "name": "{ruleid}", "item": [ { "name": "Define new rule for the policy", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": " {\n \"name\": \"Factor and IP Rule\",\n \"status\": \"Active\",\n \"note\": \"Factor and IP Rule\",\n \"conditionMap\": [\n {\n \"key\": \"IpGroupCondition\",\n \"value\": {\n \"mode\": \"BASIC\",\n \"expression\": \"context.ip.inGroup(113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b)\",\n \"values\": [\n \"113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b\"\n ],\n \"isgroup\": true,\n \"attribute\": \"Context.IPAddress\",\n \"operator\": \"In Group\"\n }\n }\n ],\n \"results\": {\n \"action\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"score\": 300,\n \"weight\": 100\n }\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid/rule", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid", "rule" ], "variable": [ { "key": "policygid", "value": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171" } ] }, "description": "Define a new rule for the policy.\n\nIn the Params tab set the value for \"policygid\" to the value of the policy to create the new rule for.\n\nIn this example a rule is created as follows:\nIf \"IP address\" is in the group \"SecureIP\" then return the factors set in the group \"FactorRuleGrp1\".\n\nHere \"expression\" is set to:\n\"context.ip.inGroup(:groupid)\" where \":groupid\" is the groupid of the \"SecureIP\" group. The parameter \"values\" is also set to the same \":groupid\".\n\n\"attribute\": \"Context.IPAddress\" defines the attribute as \"IPAddress\" and the \"operator\": \"In Group\" defines the operator. \n\nIn \"results\" the \"action\" is set to the value of the \":groupid\" of the \"FactorRuleGrp1\" group.\n\nIn the response the \"rulegid\" is returned. The \"rulegid\" is required to perform other operations where \"rulegid\" is required." }, "response": [ { "name": "Example Success Response - Define new rule for the policy", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": " {\n \"name\": \"Factor and IP Rule\",\n \"status\": \"Active\",\n \"note\": \"Factor and IP Rule\",\n \"conditionMap\": [\n {\n \"key\": \"IpGroupCondition\",\n \"value\": {\n \"mode\": \"BASIC\",\n \"expression\": \"context.ip.inGroup(113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b)\",\n \"values\": [\n \"113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b\"\n ],\n \"isgroup\": true,\n \"attribute\": \"Context.IPAddress\",\n \"operator\": \"In Group\"\n }\n }\n ],\n \"results\": {\n \"action\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"score\": 300,\n \"weight\": 100\n }\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid/rule", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid", "rule" ], "variable": [ { "key": "policygid", "value": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 13:35:10 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "1022" } ], "cookie": [], "body": "{\n \"status\": \"201\",\n \"message\": \"Rule created successfully.\",\n \"rulegid\": \"146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a\",\n \"rule\": {\n \"name\": \"Factor and IP Rule\",\n \"rulegid\": \"146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a\",\n \"policygid\": \"141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171\",\n \"status\": \"ACTIVE\",\n \"note\": \"Factor and IP Rule\",\n \"conditions\": [\n {\n \"conditionKey\": \"always_on_user.condition0\",\n \"conditionId\": \"145_5f7d4a93ac1ad362c70a43a9b64351cf6789b3a0c55b425145c374aca7628bc1\",\n \"parameters\": [\n {\n \"paramname\": \"isTrue\",\n \"value\": \"true\"\n }\n ]\n }\n ],\n \"conditionMap\": [\n {\n \"key\": \"IpGroupCondition\",\n \"value\": {\n \"mode\": \"BASIC\",\n \"expression\": \"context.ip.inGroup(113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b)\",\n \"values\": [\n \"113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b\"\n ],\n \"isgroup\": true,\n \"attribute\": \"Context.IPAddress\",\n \"operator\": \"In Group\"\n }\n }\n ],\n \"results\": {\n \"action\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"score\": 300,\n \"weight\": 100\n }\n }\n}" } ] }, { "name": "Get rule for a given policy", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid/rule/:rulegid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid", "rule", ":rulegid" ], "variable": [ { "key": "policygid", "value": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171", "description": "(Required) global id of the policy" }, { "key": "rulegid", "value": "146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a" } ] }, "description": "Get a rule for a given policy.\n\nIn the Params tab set the value of \"rulegid\" and \"policygid\" to fetch for the rule associated with that policy." }, "response": [ { "name": "Example Success Response - Get rule for a given policy", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid/rule/:rulegid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid", "rule", ":rulegid" ], "variable": [ { "key": "policygid", "value": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171", "description": "(Required) global id of the policy" }, { "key": "rulegid", "value": "146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 13:36:30 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "1013" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Rule information.\",\n \"rulegid\": \"146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a\",\n \"rule\": {\n \"name\": \"Factor and IP Rule\",\n \"rulegid\": \"146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a\",\n \"policygid\": \"141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171\",\n \"status\": \"ACTIVE\",\n \"note\": \"Factor and IP Rule\",\n \"conditions\": [\n {\n \"conditionKey\": \"always_on_user.condition0\",\n \"conditionId\": \"145_5f7d4a93ac1ad362c70a43a9b64351cf6789b3a0c55b425145c374aca7628bc1\",\n \"parameters\": [\n {\n \"paramname\": \"isTrue\",\n \"value\": \"true\"\n }\n ]\n }\n ],\n \"conditionMap\": [\n {\n \"key\": \"IpGroupCondition\",\n \"value\": {\n \"mode\": \"BASIC\",\n \"expression\": \"context.ip.inGroup(113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b)\",\n \"values\": [\n \"113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b\"\n ],\n \"isgroup\": true,\n \"attribute\": \"Context.IPAddress\",\n \"operator\": \"In Group\"\n }\n }\n ],\n \"results\": {\n \"action\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"score\": 300,\n \"weight\": 100\n }\n }\n}" } ] }, { "name": "Return all policy rules which belongs to the given policy name", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid/rule", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid", "rule" ], "variable": [ { "key": "policygid", "value": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171" } ] }, "description": "Return all policy rules which belong to the given policy name.\n\nIn the Params tab set the value of \"policygid\" to the policy to fetch the rules for." }, "response": [ { "name": "Example Success Response - Return all policy rules which belongs to the given policy name", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid/rule", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid", "rule" ], "variable": [ { "key": "policygid", "value": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 13:37:28 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "936" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Rules information.\",\n \"rules\": [\n {\n \"name\": \"Factor and IP Rule\",\n \"rulegid\": \"146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a\",\n \"policygid\": \"141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171\",\n \"status\": \"ACTIVE\",\n \"note\": \"Factor and IP Rule\",\n \"conditions\": [\n {\n \"conditionKey\": \"always_on_user.condition0\",\n \"conditionId\": \"145_5f7d4a93ac1ad362c70a43a9b64351cf6789b3a0c55b425145c374aca7628bc1\",\n \"parameters\": [\n {\n \"paramname\": \"isTrue\",\n \"value\": \"true\"\n }\n ]\n }\n ],\n \"conditionMap\": [\n {\n \"key\": \"IpGroupCondition\",\n \"value\": {\n \"mode\": \"BASIC\",\n \"expression\": \"context.ip.inGroup(113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b)\",\n \"values\": [\n \"113_91d0cc32aecf15d094e3953b17a7dd904a3fb71d2f4152934efb56caa898796b\"\n ],\n \"isgroup\": true,\n \"attribute\": \"Context.IPAddress\",\n \"operator\": \"In Group\"\n }\n }\n ],\n \"results\": {\n \"action\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"score\": 300,\n \"weight\": 100\n }\n }\n ]\n}" } ] }, { "name": "Update the rule of the given policy", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": " {\n \"name\": \"Factor and IP Range Rule\",\n \"status\": \"Active\",\n \"note\": \"Factor and IP Rule update\",\n \"conditionMap\": [\n {\n \"key\": \"IpGroupCondition\",\n \"value\": {\n \"mode\": \"BASIC\",\n \"expression\": \"context.ip.inRange('127_ddd32e7186d66b2cb96cc4608ded0bb7d6ae4a48b1fc1894c69e715cf262e7ad')\",\n \"values\": [\n \"127_ddd32e7186d66b2cb96cc4608ded0bb7d6ae4a48b1fc1894c69e715cf262e7ad\"\n ],\n \"isgroup\": true,\n \"attribute\": \"Context.IPAddress\",\n \"operator\": \"In Range\"\n }\n }\n ],\n \"results\": {\n \"action\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"score\": 300,\n \"weight\": 100\n }\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid/rule/:rulegid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid", "rule", ":rulegid" ], "variable": [ { "key": "policygid", "value": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171", "description": "(Required) global id of the policy" }, { "key": "rulegid", "value": "146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a" } ] }, "description": "Update an existing rule for a policy.\n\nIn the Params tab set the value for \"policygid\" to the value of the policy and \"rulegid\" to update.\n\nIn this example a rule is updated to set the condition as follows:\nIf \"IP address\" is in the range of IP's defined in the \"Secure IP Range\" group\nthen return the factors set in the group \"FactorRuleGrp1\".\n\nHere \"expression\" is set to:\n\"context.ip.inRange(:groupid)\" where \":groupid\" is the groupid of the \"Secure IP Range\" group. The parameter \"values\" is also set to the same \":groupid\".\n\n\"attribute\": \"Context.IPAddress\" defines the attribute as \"IPAddress\" and the \"operator\": \"In Range\" defines the operator. \n\nIn \"results\" the \"action\" is set to the value of the \":groupid\" of the \"FactorRuleGrp1\" group." }, "response": [ { "name": "Example Success Response - Update the rule of the given policy", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": " {\n \"name\": \"Factor and IP Range Rule\",\n \"status\": \"Active\",\n \"note\": \"Factor and IP Rule update\",\n \"conditionMap\": [\n {\n \"key\": \"IpGroupCondition\",\n \"value\": {\n \"mode\": \"BASIC\",\n \"expression\": \"context.ip.inRange(127_ddd32e7186d66b2cb96cc4608ded0bb7d6ae4a48b1fc1894c69e715cf262e7ad)\",\n \"values\": [\n \"127_ddd32e7186d66b2cb96cc4608ded0bb7d6ae4a48b1fc1894c69e715cf262e7ad\"\n ],\n \"isgroup\": true,\n \"attribute\": \"Context.IPAddress\",\n \"operator\": \"In Range\"\n }\n }\n ],\n \"results\": {\n \"action\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"score\": 300,\n \"weight\": 100\n }\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid/rule/:rulegid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid", "rule", ":rulegid" ], "variable": [ { "key": "policygid", "value": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171", "description": "(Required) global id of the policy" }, { "key": "rulegid", "value": "146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Wed, 21 Apr 2021 08:24:10 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "1035" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Rule updated successfully.\",\n \"rulegid\": \"146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a\",\n \"rule\": {\n \"name\": \"Factor and IP Range Rule\",\n \"rulegid\": \"146_faef323e5ee26bac62d48a9bf9ded1da3f9655731566b0e3628ce86e21c9e46a\",\n \"policygid\": \"141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171\",\n \"status\": \"ACTIVE\",\n \"note\": \"Factor and IP Rule update\",\n \"conditions\": [\n {\n \"conditionKey\": \"always_on_user.condition0\",\n \"conditionId\": \"145_5f7d4a93ac1ad362c70a43a9b64351cf6789b3a0c55b425145c374aca7628bc1\",\n \"parameters\": [\n {\n \"paramname\": \"isTrue\",\n \"value\": \"true\"\n }\n ]\n }\n ],\n \"conditionMap\": [\n {\n \"key\": \"IpGroupCondition\",\n \"value\": {\n \"mode\": \"BASIC\",\n \"expression\": \"context.ip.inRange(127_ddd32e7186d66b2cb96cc4608ded0bb7d6ae4a48b1fc1894c69e715cf262e7ad)\",\n \"values\": [\n \"127_ddd32e7186d66b2cb96cc4608ded0bb7d6ae4a48b1fc1894c69e715cf262e7ad\"\n ],\n \"isgroup\": true,\n \"attribute\": \"Context.IPAddress\",\n \"operator\": \"In Range\"\n }\n }\n ],\n \"results\": {\n \"action\": \"111_4141dd92a40fa2ff8d09153e62c658c67f3c7ac014ce89c0c103896230457718\",\n \"score\": 300,\n \"weight\": 100\n }\n }\n}" } ] }, { "name": "Delete the rule from the policy store", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid/rule/:rulegid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid", "rule", ":rulegid" ], "variable": [ { "key": "policygid", "value": "296_1002a0512b7458875b47481bd5bbed3d09e741543ad583dccb7348e8b4a0522e", "description": "(Required) global id of the policy" }, { "key": "rulegid", "value": "301_593fbf2846d3ac696d451ce989a308cd06dc6b47f9e22b390d864d80fa1d14eb" } ] }, "description": "Delete the rule from policy store.\n\nIn the Params tab set the value of \"rulegid\" and \"policygid\" to delete the rule associated with that policy.\n\n" }, "response": [ { "name": "Example Success Response - Delete the rule from the policy store", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid/rule/:rulegid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid", "rule", ":rulegid" ], "variable": [ { "key": "policygid", "value": "296_1002a0512b7458875b47481bd5bbed3d09e741543ad583dccb7348e8b4a0522e", "description": "(Required) global id of the policy" }, { "key": "rulegid", "value": "301_593fbf2846d3ac696d451ce989a308cd06dc6b47f9e22b390d864d80fa1d14eb" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 4 Mar 2021 14:12:04 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "852" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Rule Deleted.\",\n \"rulegid\": \"301_593fbf2846d3ac696d451ce989a308cd06dc6b47f9e22b390d864d80fa1d14eb\",\n \"rule\": {\n \"name\": \"AssuranceLevel2\",\n \"rulegid\": \"301_593fbf2846d3ac696d451ce989a308cd06dc6b47f9e22b390d864d80fa1d14eb\",\n \"policygid\": \"296_1002a0512b7458875b47481bd5bbed3d09e741543ad583dccb7348e8b4a0522e\",\n \"ruleversion\": null,\n \"status\": \"ACTIVE\",\n \"note\": \"2\",\n \"transactiongid\": null,\n \"conditions\": null,\n \"conditionMap\": [\n {\n \"key\": \"1\",\n \"value\": {\n \"mode\": \"BASIC\",\n \"expression\": \"context.ip.inRange('239_8d2b04fe80fcf0a3a543783eb64c710b4713a2fa7a6fe5727c892d4350e7b72b')\",\n \"values\": [\n \"239_8d2b04fe80fcf0a3a543783eb64c710b4713a2fa7a6fe5727c892d4350e7b72b\"\n ],\n \"isgroup\": false,\n \"attribute\": \"Context.IPAddress\",\n \"operator\": \"In Range\"\n }\n }\n ],\n \"results\": {\n \"action\": \"297_4269a2c419e02f5825186893cc63ef2443214a6f3fc46dbe65e5ee1891c1bf53\",\n \"alert\": null,\n \"score\": 1000,\n \"weight\": 100\n }\n }\n}" } ] } ] } ] }, { "name": "Create new policy", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"assuranceLevelId\": \"AssuranceLevel1\",\n \"name\": \"Policy1\",\n \"description\": \"Policy for AssuranceLevel1\",\n \"status\": \"Active\"\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1" ] }, "description": "Create a policy for an assurance level for a specific \"agentgid\".\n\nIn the Body set the \"agentgid\" to the integration agent you want to create the policy for. Set \"checkpointkey\" to the name of the Assurance Level to assign the policy to.\n\nIn the response the \"policygid\" of the created policy is returned. This is required for other API operations where the policygid is passed." }, "response": [ { "name": "Example Success Response - Create new policy", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"assuranceLevelId\": \"AssuranceLevel1\",\n \"name\": \"Policy1\",\n \"description\": \"Policy for AssuranceLevel1\",\n \"status\": \"Active\"\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 11:13:39 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "438" } ], "cookie": [], "body": "{\n \"status\": \"201\",\n \"message\": \"Policy created successfully.\",\n \"policygid\": \"141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171\",\n \"policy\": {\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"assuranceLevelId\": \"AssuranceLevel1\",\n \"name\": \"Policy1\",\n \"description\": \"Policy for AssuranceLevel1\",\n \"status\": \"ACTIVE\",\n \"scoringEngine\": \"Average\",\n \"weight\": 100,\n \"policygid\": \"141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171\"\n }\n}" } ] }, { "name": "Get the policy", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid" ], "variable": [ { "key": "policygid", "value": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171" } ] }, "description": "Get a policy from the store.\n\nIn the Params tab update the value for \"policygid\" with the policy to fetch." }, "response": [ { "name": "Example Success Response - Get the policy", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid" ], "variable": [ { "key": "policygid", "value": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 13:24:43 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "429" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Policy information.\",\n \"policygid\": \"141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171\",\n \"policy\": {\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"assuranceLevelId\": \"AssuranceLevel1\",\n \"name\": \"Policy1\",\n \"description\": \"Policy for AssuranceLevel1\",\n \"status\": \"ACTIVE\",\n \"scoringEngine\": \"Average\",\n \"weight\": 100,\n \"policygid\": \"141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171\"\n }\n}" } ] }, { "name": "Get all policies for the given assuranceLevel", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1?levelId=AssuranceLevel1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1" ], "query": [ { "key": "levelId", "value": "AssuranceLevel1", "description": "(Required) Key of the assusranceLevel which controls the policies." } ] }, "description": "Fetch all policies assigned to an Assurance Level.\n\nIn the Params tab set the value of \"levelId\" to the Assurance Level for whom to fetch policies for." }, "response": [ { "name": "Example Success Response - Get all policies for the given assuranceLevel", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1?levelId=AssuranceLevel1", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1" ], "query": [ { "key": "levelId", "value": "AssuranceLevel1", "description": "(Required) Key of the assusranceLevel which controls the policies." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 15:27:22 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "364" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Policy information.\",\n \"policies\": [\n {\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"assuranceLevelId\": \"AssuranceLevel1\",\n \"name\": \"Policy1 Update\",\n \"description\": \"Policy for AssuranceLevel1 Update\",\n \"status\": \"ACTIVE\",\n \"scoringEngine\": \"Average\",\n \"weight\": 100,\n \"policygid\": \"141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171\"\n }\n ]\n}" } ] }, { "name": "Update the policy", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"name\": \"Policy1 Update\",\n \"description\": \"Policy for AssuranceLevel1 Update\",\n \"status\": \"Active\",\n \"assuranceLevelId\": \"AssuranceLevel1\"\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid" ], "variable": [ { "key": "policygid", "value": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171" } ] }, "description": "Update a policy for a specific \"agentgid\".\n\nIn the Params tab update the value of \"policygid\" to the value of the policy to update.\n\nIn the Body set the \"agentgid\" to the agent you want to update the policy for. " }, "response": [ { "name": "Example Success Response - Update the policy", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"name\": \"Policy1 Update\",\n \"description\": \"Policy for AssuranceLevel1 Update\",\n \"status\": \"Active\",\n \"assuranceLevelId\": \"AssuranceLevel1\"\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid" ], "variable": [ { "key": "policygid", "value": "141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 13:29:09 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "454" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Policy update is successfully.\",\n \"policygid\": \"141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171\",\n \"policy\": {\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"assuranceLevelId\": \"AssuranceLevel1\",\n \"name\": \"Policy1 Update\",\n \"description\": \"Policy for AssuranceLevel1 Update\",\n \"status\": \"ACTIVE\",\n \"scoringEngine\": \"Average\",\n \"weight\": 100,\n \"policygid\": \"141_73875f1eda644e4196248e5ecc824364c5a6c1954350a9927942c6d50c4ed171\"\n }\n}" } ] }, { "name": "Delete policy from the policy store", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid" ], "variable": [ { "key": "policygid", "value": "142_32c7815cfac3ff85bd90832315021aa98a66cfab2fd141e7ea7916d2e466f241" } ] }, "description": "Delete a policy from the store.\n\nIn the Params tab set the \"policygid\" value to the value of the policy to delete." }, "response": [ { "name": "Example Success Response - Delete policy from the policy store", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/:policygid", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", ":policygid" ], "variable": [ { "key": "policygid", "value": "142_32c7815cfac3ff85bd90832315021aa98a66cfab2fd141e7ea7916d2e466f241" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 13:32:30 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "438" } ], "cookie": [], "body": "{\n \"status\": \"200\",\n \"message\": \"Policy deleted successfully.\",\n \"policygid\": \"142_32c7815cfac3ff85bd90832315021aa98a66cfab2fd141e7ea7916d2e466f241\",\n \"policy\": {\n \"agentgid\": \"dede64d3-1d6a-42e9-89e1-714e88f8967c\",\n \"assuranceLevelId\": \"AssuranceLevel1\",\n \"name\": \"Policy2\",\n \"description\": \"Policy for AssuranceLevel1\",\n \"status\": \"ACTIVE\",\n \"scoringEngine\": \"Average\",\n \"weight\": 100,\n \"policygid\": \"142_32c7815cfac3ff85bd90832315021aa98a66cfab2fd141e7ea7916d2e466f241\"\n }\n}" } ] } ] }, { "name": "Policy evaluation API", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"expression\": \"context.ip.inRange('127_ddd32e7186d66b2cb96cc4608ded0bb7d6ae4a48b1fc1894c69e715cf262e7ad')\"\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/expression", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", "expression" ] }, "description": "Evaluate policy expression present in the request and return success if the expression can be evaluated to true or false. If the expression cannot be evaluated due to syntax or compilation error it will return an error." }, "response": [ { "name": "Example Success Response - Policy evaluation API", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"expression\": \"context.ip.inRange('127_ddd32e7186d66b2cb96cc4608ded0bb7d6ae4a48b1fc1894c69e715cf262e7ad')\"\n}" }, "url": { "raw": "{{oaa-policy}}/oaa-policy/policy/v1/expression", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "policy", "v1", "expression" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 13:51:51 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "126" } ], "cookie": [], "body": "{\n \"expression\": \"context.ip.inRange('127_ddd32e7186d66b2cb96cc4608ded0bb7d6ae4a48b1fc1894c69e715cf262e7ad')\",\n \"status\": \"SUCCESS\"\n}" } ] } ], "description": "Use this collection to create, update, fetch and delete policies and policy rules." }, { "name": "Aggregation Api", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"agentname\" : \"AggregationAPIAgent\",\n \"assuranceLevelId\" : \"AggregationAgentAssuranceLevel\",\n \"type\" : \"API\",\n \"actions\" : [\"ChallengeEmail\" , \"ChallengeSMS\" , \"ChallengeOMATOTP\", \"ChallengeYubicoOTP\", \"ChallengeFIDO2\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{oaa-policy}}/oaa-policy/aggregation/v1?detailresponse=true", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "aggregation", "v1" ], "query": [ { "key": "detailresponse", "value": "true" } ] }, "description": "Create a new Integration Agent, Assurance Level, Group and Policy with the provided actions in one operation.\n\n\nIn this example an agent is created called \"AggregationAPIAgent\" with an associated Assurance Level. It creates an action group with the factors \"ChallengeEmail\", \"ChallengeSMS\", \"ChallengeOMATOTP\", \"ChallengeYubicoOTP\" and \"ChallengeFIDO2\". It creates a Policy and associated rule that sets the group of factors." }, "response": [ { "name": "Example Success Response - Aggregation Api", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"agentname\" : \"AggregationAPIAgent\",\n \"assuranceLevelId\" : \"AggregationAgentAssuranceLevel\",\n \"type\" : \"API\",\n \"actions\" : [\"ChallengeEmail\" , \"ChallengeSMS\" , \"ChallengeOMATOTP\", \"ChallengeYubicoOTP\", \"ChallengeFIDO2\"]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{oaa-policy}}/oaa-policy/aggregation/v1?detailresponse=true", "host": [ "{{oaa-policy}}" ], "path": [ "oaa-policy", "aggregation", "v1" ], "query": [ { "key": "detailresponse", "value": "true" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 13:49:20 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "2014" } ], "cookie": [], "body": "{\n \"agent\": {\n \"agentName\": \"AggregationAPIAgent\",\n \"clientId\": \"da3b521d-5ec2-4956-a412-046df1c8c9ea\",\n \"clientSecret\": \"8cce2702-824b-4377-b1a3-99419cfcec7f\",\n \"clientType\": \"api\",\n \"agentgid\": \"0463b32d-70a1-4ca8-81e1-58f1a8728690\",\n \"createTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T01:49:20.470Z\",\n \"rawParam\": \"2021-04-01T01:49:20.470Z\"\n },\n \"updateTime\": {\n \"parseFailed\": false,\n \"dateTime\": \"2021-04-01T01:49:20.471Z\",\n \"rawParam\": \"2021-04-01T01:49:20.471Z\"\n }\n },\n \"assuranceLevel\": {\n \"id\": \"AggregationAgentAssuranceLevel\",\n \"name\": \"AggregationAgentAssuranceLevel\",\n \"description\": \"Created by Aggregation API for agentAggregationAPIAgent\",\n \"agentid\": \"0463b32d-70a1-4ca8-81e1-58f1a8728690\"\n },\n \"policy\": {\n \"agentgid\": \"0463b32d-70a1-4ca8-81e1-58f1a8728690\",\n \"assuranceLevelId\": \"AggregationAgentAssuranceLevel\",\n \"name\": \"AggregationAPIAgent68d3f589\",\n \"description\": \"Created by Aggregation API for agentAggregationAPIAgent\",\n \"status\": \"ACTIVE\",\n \"scoringEngine\": \"Weighted Average\",\n \"weight\": 100,\n \"policygid\": \"174_128fe9d6967edf9c90283c84e002d18d211cbe082bf168b1376e3e07e4512dcd\"\n },\n \"rule\": {\n \"name\": \"AggregationAPIAgent68d3f589\",\n \"rulegid\": \"178_663c4a4fbb4c6ef1bd9c9563c259de2de7baad626921de3255a8b633e32fc1be\",\n \"policygid\": \"174_128fe9d6967edf9c90283c84e002d18d211cbe082bf168b1376e3e07e4512dcd\",\n \"status\": \"ACTIVE\",\n \"note\": \"Created by Aggregation API for agentAggregationAPIAgent\",\n \"conditions\": [\n {\n \"conditionKey\": \"always_on_user.condition0\",\n \"conditionId\": \"177_192b8bdc19927812d85ec01c71664b670290596c9d171eeaa82e46a63ffb5688\",\n \"parameters\": [\n {\n \"paramname\": \"isTrue\",\n \"value\": \"true\"\n }\n ]\n }\n ],\n \"results\": {\n \"action\": \"173_db05090771e58ef53d0549c7014a090613b96b6f5a90f2347abe59d1fdc9a292\",\n \"score\": 1000,\n \"weight\": 100\n }\n },\n \"group\": {\n \"groupid\": \"173_db05090771e58ef53d0549c7014a090613b96b6f5a90f2347abe59d1fdc9a292\",\n \"agentid\": \"0463b32d-70a1-4ca8-81e1-58f1a8728690\",\n \"grouptype\": \"Actions\",\n \"groupname\": \"AggregationAPIAgent68d3f589\",\n \"description\": \"Created by Aggregation API for agentAggregationAPIAgent\",\n \"values\": [\n \"ChallengeEmail\",\n \"ChallengeSMS\",\n \"ChallengeOMATOTP\",\n \"ChallengeYubicoOTP\",\n \"ChallengeFIDO2\"\n ]\n }\n}" } ] } ], "description": "This API describes Agents, Groups, Policy, and rules associated with polices. Also checkpoint (Assurance Levels) can be defined which will invoke specific policies during runtime. \n\nThe order of execution is:\nCreate Agent\nCreate Checkpoint (Assurance Level)\nCreate Group\nCreate Policy \nCreate Policy Rule (using Group ID)\n", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "REST API for Configuration Property Management", "item": [ { "name": "config/property/v1", "item": [ { "name": "Creates or updates factor configuration properties", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptmessage\",\n \"value\": \"Send OTP to {0}\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptselectmessage\",\n \"value\": \"Please select one of following addresses to receive OTP.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.challengeText\",\n \"value\": \"Enter OTP sent to {0}.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgSubject\",\n \"value\": \"One Time PIN: Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgPinTemplate\",\n \"value\": \"Please use following one time pin to login to the protected resource:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate\",\n \"value\": \"Time of Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate\",\n \"value\": \"Resource URL Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress\",\n \"value\": \"security@example.com\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromName\",\n \"value\": \"Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.appName\",\n \"value\": \"OAA\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptmessage\",\n \"value\": \"Send OTP to phone {0}\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptselectmessage\",\n \"value\": \"Please select one of following numbers to receive OTP.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.challengeText\",\n \"value\": \"Enter OTP sent to {0}.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgSubject\",\n \"value\": \"One Time PIN: Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgPinTemplate\",\n \"value\": \"Please use following one time pin to login to the protected resource:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate\",\n \"value\": \"Time of Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgIPTemplate\",\n \"value\": \"IP Address:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgResourceURLTemplate\",\n \"value\": \"Resource URL Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromAddress\",\n \"value\": \"security@example.com\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromName\",\n \"value\": \"Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.appName\",\n \"value\": \"OAA\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeTOTP.promptmessage\",\n \"value\": \"Enter OTP from registered phone\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.promptselectmessage\",\n \"value\": \"Please select one of following channels\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.challengeText\",\n \"value\": \"Enter OTP from device {1}\"\n }\n]" }, "url": { "raw": "{{oaa-policy}}/policy/config/property/v1", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ] }, "description": "Create or update properties for OAA.\n\n" }, "response": [ { "name": "Example Success Response - Creates or updates configuration properties that are provided in the input", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptmessage\",\n \"value\": \"Send OTP to {0}\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptselectmessage\",\n \"value\": \"Please select one of following addresses to receive OTP.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.challengeText\",\n \"value\": \"Enter OTP sent to {0}.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgSubject\",\n \"value\": \"One Time PIN: Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgPinTemplate\",\n \"value\": \"Please use following one time pin to login to the protected resource:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate\",\n \"value\": \"Time of Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate\",\n \"value\": \"Resource URL Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress\",\n \"value\": \"security@example.com\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromName\",\n \"value\": \"Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.appName\",\n \"value\": \"OAA\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptmessage\",\n \"value\": \"Send OTP to phone {0}\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptselectmessage\",\n \"value\": \"Please select one of following numbers to receive OTP.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.challengeText\",\n \"value\": \"Enter OTP sent to {0}.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgSubject\",\n \"value\": \"One Time PIN: Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgPinTemplate\",\n \"value\": \"Please use following one time pin to login to the protected resource:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate\",\n \"value\": \"Time of Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgIPTemplate\",\n \"value\": \"IP Address:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgResourceURLTemplate\",\n \"value\": \"Resource URL Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromAddress\",\n \"value\": \"security@example.com\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromName\",\n \"value\": \"Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.appName\",\n \"value\": \"OAA\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeTOTP.promptmessage\",\n \"value\": \"Enter OTP from registered phone\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.promptselectmessage\",\n \"value\": \"Please select one of following channels\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.challengeText\",\n \"value\": \"Enter OTP from device {1}\"\n }\n]" }, "url": { "raw": "{{oaa-policy}}/policy/config/property/v1", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Fri, 5 Mar 2021 11:18:57 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "3287" } ], "cookie": [], "body": "[\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptmessage\",\n \"value\": \"Send OTP to {0}\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptselectmessage\",\n \"value\": \"Please select one of following addresses to receive OTP.\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.challengeText\",\n \"value\": \"Enter OTP sent to {0}.\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgSubject\",\n \"value\": \"One Time PIN: Example Company\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgPinTemplate\",\n \"value\": \"Please use following one time pin to login to the protected resource:\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate\",\n \"value\": \"Time of Access:\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate\",\n \"value\": \"Resource URL Access:\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress\",\n \"value\": \"security@example.com\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromName\",\n \"value\": \"Example Company\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.appName\",\n \"value\": \"OAA\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptmessage\",\n \"value\": \"Send OTP to phone {0}\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptselectmessage\",\n \"value\": \"Please select one of following numbers to receive OTP.\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.challengeText\",\n \"value\": \"Enter OTP sent to {0}.\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgSubject\",\n \"value\": \"One Time PIN: Example Company\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgPinTemplate\",\n \"value\": \"Please use following one time pin to login to the protected resource:\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate\",\n \"value\": \"Time of Access:\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgIPTemplate\",\n \"value\": \"IP Address:\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgResourceURLTemplate\",\n \"value\": \"Resource URL Access:\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromAddress\",\n \"value\": \"security@example.com\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromName\",\n \"value\": \"Example Company\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.appName\",\n \"value\": \"OAA\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeTOTP.promptmessage\",\n \"value\": \"Enter OTP from registered phone\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.promptselectmessage\",\n \"value\": \"Please select one of following channels\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.challengeText\",\n \"value\": \"Enter OTP from device {1}\",\n \"source\": \"database\"\n }\n]" } ] }, { "name": "Update factor verification", "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptmessage\",\n \"value\": \"Send OTP to {0}\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptselectmessage\",\n \"value\": \"Please select one of following addresses to receive OTP.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.challengeText\",\n \"value\": \"Enter OTP sent to {0}.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgSubject\",\n \"value\": \"One Time PIN: Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgPinTemplate\",\n \"value\": \"Please use following one time pin to login to the protected resource:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate\",\n \"value\": \"Time of Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate\",\n \"value\": \"Resource URL Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress\",\n \"value\": \"security@example.com\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromName\",\n \"value\": \"Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.appName\",\n \"value\": \"OAA\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptmessage\",\n \"value\": \"Send OTP to phone {0}\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptselectmessage\",\n \"value\": \"Please select one of following numbers to receive OTP.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.challengeText\",\n \"value\": \"Enter OTP sent to {0}.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgSubject\",\n \"value\": \"One Time PIN: Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgPinTemplate\",\n \"value\": \"Please use following one time pin to login to the protected resource:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate\",\n \"value\": \"Time of Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgIPTemplate\",\n \"value\": \"IP Address:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgResourceURLTemplate\",\n \"value\": \"Resource URL Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromAddress\",\n \"value\": \"security@example.com\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromName\",\n \"value\": \"Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.appName\",\n \"value\": \"OAA\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeTOTP.promptmessage\",\n \"value\": \"Enter OTP from registered phone\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.promptselectmessage\",\n \"value\": \"Please select one of following channels\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.challengeText\",\n \"value\": \"Enter OTP from device {1}\"\n }\n]" }, "url": { "raw": "{{oaa-policy}}/policy/config/property/v1", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ] }, "description": "Create or update properties for OAA.\n\n" }, "response": [ { "name": "Example Success Response - Creates or updates configuration properties that are provided in the input", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptmessage\",\n \"value\": \"Send OTP to {0}\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptselectmessage\",\n \"value\": \"Please select one of following addresses to receive OTP.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.challengeText\",\n \"value\": \"Enter OTP sent to {0}.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgSubject\",\n \"value\": \"One Time PIN: Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgPinTemplate\",\n \"value\": \"Please use following one time pin to login to the protected resource:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate\",\n \"value\": \"Time of Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate\",\n \"value\": \"Resource URL Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress\",\n \"value\": \"security@example.com\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromName\",\n \"value\": \"Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.appName\",\n \"value\": \"OAA\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptmessage\",\n \"value\": \"Send OTP to phone {0}\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptselectmessage\",\n \"value\": \"Please select one of following numbers to receive OTP.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.challengeText\",\n \"value\": \"Enter OTP sent to {0}.\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgSubject\",\n \"value\": \"One Time PIN: Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgPinTemplate\",\n \"value\": \"Please use following one time pin to login to the protected resource:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate\",\n \"value\": \"Time of Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgIPTemplate\",\n \"value\": \"IP Address:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgResourceURLTemplate\",\n \"value\": \"Resource URL Access:\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromAddress\",\n \"value\": \"security@example.com\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromName\",\n \"value\": \"Example Company\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.appName\",\n \"value\": \"OAA\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeTOTP.promptmessage\",\n \"value\": \"Enter OTP from registered phone\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.promptselectmessage\",\n \"value\": \"Please select one of following channels\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.challengeText\",\n \"value\": \"Enter OTP from device {1}\"\n }\n]" }, "url": { "raw": "{{oaa-policy}}/policy/config/property/v1", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Fri, 5 Mar 2021 11:18:57 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "3287" } ], "cookie": [], "body": "[\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptmessage\",\n \"value\": \"Send OTP to {0}\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptselectmessage\",\n \"value\": \"Please select one of following addresses to receive OTP.\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.challengeText\",\n \"value\": \"Enter OTP sent to {0}.\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgSubject\",\n \"value\": \"One Time PIN: Example Company\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgPinTemplate\",\n \"value\": \"Please use following one time pin to login to the protected resource:\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate\",\n \"value\": \"Time of Access:\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate\",\n \"value\": \"Resource URL Access:\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress\",\n \"value\": \"security@example.com\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromName\",\n \"value\": \"Example Company\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.appName\",\n \"value\": \"OAA\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptmessage\",\n \"value\": \"Send OTP to phone {0}\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptselectmessage\",\n \"value\": \"Please select one of following numbers to receive OTP.\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.challengeText\",\n \"value\": \"Enter OTP sent to {0}.\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgSubject\",\n \"value\": \"One Time PIN: Example Company\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgPinTemplate\",\n \"value\": \"Please use following one time pin to login to the protected resource:\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate\",\n \"value\": \"Time of Access:\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgIPTemplate\",\n \"value\": \"IP Address:\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgResourceURLTemplate\",\n \"value\": \"Resource URL Access:\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromAddress\",\n \"value\": \"security@example.com\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromName\",\n \"value\": \"Example Company\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeSMS.appName\",\n \"value\": \"OAA\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeTOTP.promptmessage\",\n \"value\": \"Enter OTP from registered phone\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.promptselectmessage\",\n \"value\": \"Please select one of following channels\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.challengeText\",\n \"value\": \"Enter OTP from device {1}\",\n \"source\": \"database\"\n }\n]" } ] }, { "name": "Customize OAA User Interfaces", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"oaa.admin.ui.theme.default.image.path.background\",\n \"value\": \"https://www.example.com/content/images/background.jpg\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.image.path.favicon\",\n \"value\": \"https://www.example.com/content/images/favicon.jpg\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.font.text.header\",\n \"value\": \"Example Company Advanced Authentication\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.font.color.header\",\n \"value\": \"#ffffff\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.font.text.title\",\n \"value\": \"Example Company OAA\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.color\",\n \"value\": \"#00688c\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.color.copyrightNotice\",\n \"value\": \"rgba(22, 21, 19, .6)\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.about\",\n \"value\": \"About Example Company\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.contactus\",\n \"value\": \"Contact us\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.legalnotice\",\n \"value\": \"Legal Notice\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.termsofuse\",\n \"value\": \"Terms of use\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.privacyright\",\n \"value\": \"Privacyright\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.about\",\n \"value\": \"http://www.example.com/us/corporate/index.html#menu-about\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.contactus\",\n \"value\": \"http://www.example.com/us/corporate/contact/index.html\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.legalnotice\",\n \"value\": \"http://www.example.com/us/legal/index.html\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.termsofuse\",\n \"value\": \"http://www.example.com/us/legal/terms/index.html\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.privacyright\",\n \"value\": \"http://www.example.com/us/legal/privacy/index.html\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.copyrightNotice\",\n \"value\": \"Copyright © 2021, Example Company and/or its affiliates. All rights reserved.\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.image.tiled.background\",\n \"value\": \"false\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.font.family\",\n \"value\": \"Oracle Sans\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.image.path.logo\",\n \"value\": \"https://www.example.com/content/images/logo.jpg\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.image.path.background\",\n \"value\": \"https://www.example.com/content/images/background.jpg\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.image.path.favicon\",\n \"value\": \"https://www.example.com/content/images/favicon.jpg\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.font.text.header\",\n \"value\": \"Example Company Advanced Authentication\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.font.color.header\",\n \"value\": \"#ffff00\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.font.text.title\",\n \"value\": \"Example Company User Preferences\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.color\",\n \"value\": \"#00688c\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.color.copyrightNotice\",\n \"value\": \"rgba(22, 21, 19, .6)\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.about\",\n \"value\": \"About Example Company\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.contactus\",\n \"value\": \"Contact us\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.legalnotice\",\n \"value\": \"Legal Notice\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.termsofuse\",\n \"value\": \"Terms of use\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.privacyright\",\n \"value\": \"Privacyright \"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.about\",\n \"value\": \"http://www.example.com/us/corporate/index.html#menu-about\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.contactus\",\n \"value\": \"http://www.example.com/us/corporate/contact/index.html\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.legalnotice\",\n \"value\": \"http://www.example.com/us/legal/index.html\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.termsofuse\",\n \"value\": \"http://www.example.com/us/legal/terms/index.html\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.privacyright\",\n \"value\": \"http://www.example.com/us/legal/privacy/index.html\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.copyrightNotice\",\n \"value\": \"Copyright © 2021, Example Company and/or its affiliates. All rights reserved.\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.image.tiled.background\",\n \"value\": \"false\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.font.family\",\n \"value\": \"Oracle Sans\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.image.path.logo\",\n \"value\": https://www.example.com/content/images/logo.jpg\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.image.path.background\",\n \"value\": \"https://www.example.com/content/images/background.jpg\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.image.path.favicon\",\n \"value\": \"https://www.example.com/content/images/favicon.jpg\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.text.title\",\n \"value\": \"Example Company - Advanced Authentication\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.color\",\n \"value\": \"#00688c\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.color.copyrightNotice\",\n \"value\": \"rgba(22, 21, 19, .6)\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.about\",\n \"value\": \"About Example Company\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.contactus\",\n \"value\": \"Contact us\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.legalnotice\",\n \"value\": \"Legal Notice\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.termsofuse\",\n \"value\": \"Terms of use\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.privacyright\",\n \"value\": \"Privacyright\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.about\",\n \"value\": \"http://www.example.com/us/corporate/index.html#menu-about\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.contactus\",\n \"value\": \"http://www.example.com/us/corporate/contact/index.html\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.legalnotice\",\n \"value\": \"http://www.example.com/us/legal/index.html\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.termsofuse\",\n \"value\": \"http://www.example.com/us/legal/terms/index.html\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.privacyright\",\n \"value\": \"http://www.example.com/us/legal/privacy/index.html\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.copyrightNotice\",\n \"value\": \"Copyright © 2021, Example Company and/or its affiliates. All rights reserved.\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.family\",\n \"value\": \"Oracle Sans\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.button.color.active\",\n \"value\": \"rgb(79, 105, 63)\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.button.color.hover\",\n \"value\": \"rgb(87, 115, 70)\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.button.color.focus\",\n \"value\": \"rgb(95, 125, 79)\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.image.tiled.background\",\n \"value\": \"false\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.color.factor\",\n \"value\": \"rgb(22, 21, 19)\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.color.factorlink\",\n \"value\": \"#00688c\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.color.label\",\n \"value\": \"rgba(22, 21, 19, .6)\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.color.header\",\n \"value\": \"rgb(22, 21, 19)\"\n }\n]" }, "url": { "raw": "{{oaa-policy}}/policy/config/property/v1", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ] }, "description": "Create or update properties for customizing the OAA Administration Console UI , User Preferences UI, or Runtime UI.\n\nFor customizing images, the value must be set to an existing image available on an external URL.\n\nFor footer parameters, all the footer specific parameters must be updated at once for the changes to be visible on the UI" }, "response": [ { "name": "Example Success Response - Customize OAA UIs", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"name\": \"oaa.admin.ui.theme.default.image.path.background\",\n \"value\": \"https://www.example.com/content/images/background.jpg\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.image.path.favicon\",\n \"value\": \"hhttps://www.example.com/content/images/favicon.jpg\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.font.text.header\",\n \"value\": \"Example Company Advanced Authentication\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.font.color.header\",\n \"value\": \"#ffffff\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.font.text.title\",\n \"value\": \"Example Company OAA\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.color\",\n \"value\": \"#00688c\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.color.copyrightNotice\",\n \"value\": \"rgba(22, 21, 19, .6)\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.about\",\n \"value\": \"About Example Company\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.contactus\",\n \"value\": \"Contact us\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.legalnotice\",\n \"value\": \"Legal Notice\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.termsofuse\",\n \"value\": \"Terms of use\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.privacyright\",\n \"value\": \"Privacyright\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.about\",\n \"value\": \"http://www.example.com/us/corporate/index.html#menu-about\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.contactus\",\n \"value\": \"http://www.example.com/us/corporate/contact/index.html\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.legalnotice\",\n \"value\": \"http://www.example.com/us/legal/index.html\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.termsofuse\",\n \"value\": \"http://www.example.com/us/legal/terms/index.html\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.privacyright\",\n \"value\": \"http://www.example.com/us/legal/privacy/index.html\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.copyrightNotice\",\n \"value\": \"Copyright © 2021, Example Company and/or its affiliates. All rights reserved.\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.image.tiled.background\",\n \"value\": \"false\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.font.family\",\n \"value\": \"Oracle Sans\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.image.path.logo\",\n \"value\": \"https://www.example.com/content/images/logo.jpg\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.image.path.background\",\n \"value\": \"https://www.example.com/content/images/background.jpg\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.image.path.favicon\",\n \"value\": \"https://www.example.com/content/images/favicon.jpg\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.font.text.header\",\n \"value\": \"Example Company Advanced Authentication\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.font.color.header\",\n \"value\": \"#ffff00\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.font.text.title\",\n \"value\": \"Example Company User Preferences\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.color\",\n \"value\": \"#00688c\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.color.copyrightNotice\",\n \"value\": \"rgba(22, 21, 19, .6)\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.about\",\n \"value\": \"About Example Company\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.contactus\",\n \"value\": \"Contact us\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.legalnotice\",\n \"value\": \"Legal Notice\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.termsofuse\",\n \"value\": \"Terms of use\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.privacyright\",\n \"value\": \"Privacyright \"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.about\",\n \"value\": \"http://www.example.com/us/corporate/index.html#menu-about\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.contactus\",\n \"value\": \"http://www.example.com/us/corporate/contact/index.html\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.legalnotice\",\n \"value\": \"http://www.example.com/us/legal/index.html\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.termsofuse\",\n \"value\": \"http://www.example.com/us/legal/terms/index.html\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.privacyright\",\n \"value\": \"http://www.example.com/us/legal/privacy/index.html\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.copyrightNotice\",\n \"value\": \"Copyright © 2021, Example Company and/or its affiliates. All rights reserved.\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.image.tiled.background\",\n \"value\": \"false\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.font.family\",\n \"value\": \"Oracle Sans\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.image.path.logo\",\n \"value\": https://www.example.com/content/images/logo.jpg\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.image.path.background\",\n \"value\": \"https://www.example.com/content/images/background.jpg\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.image.path.favicon\",\n \"value\": \"https://www.example.com/content/images/favicon.jpg\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.text.title\",\n \"value\": \"Example Company - Advanced Authentication\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.color\",\n \"value\": \"#00688c\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.color.copyrightNotice\",\n \"value\": \"rgba(22, 21, 19, .6)\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.about\",\n \"value\": \"About Example Company\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.contactus\",\n \"value\": \"Contact us\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.legalnotice\",\n \"value\": \"Legal Notice\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.termsofuse\",\n \"value\": \"Terms of use\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.privacyright\",\n \"value\": \"Privacyright\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.about\",\n \"value\": \"http://www.example.com/us/corporate/index.html#menu-about\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.contactus\",\n \"value\": \"http://www.example.com/us/corporate/contact/index.html\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.legalnotice\",\n \"value\": \"http://www.example.com/us/legal/index.html\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.termsofuse\",\n \"value\": \"http://www.example.com/us/legal/terms/index.html\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.privacyright\",\n \"value\": \"http://www.example.com/us/legal/privacy/index.html\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.copyrightNotice\",\n \"value\": \"Copyright © 2021, Example Company and/or its affiliates. All rights reserved.\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.family\",\n \"value\": \"Oracle Sans\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.button.color.active\",\n \"value\": \"rgb(79, 105, 63)\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.button.color.hover\",\n \"value\": \"rgb(87, 115, 70)\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.button.color.focus\",\n \"value\": \"rgb(95, 125, 79)\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.image.tiled.background\",\n \"value\": \"false\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.color.factor\",\n \"value\": \"rgb(22, 21, 19)\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.color.factorlink\",\n \"value\": \"#00688c\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.color.label\",\n \"value\": \"rgba(22, 21, 19, .6)\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.color.header\",\n \"value\": \"rgb(22, 21, 19)\"\n }\n]" }, "url": { "raw": "{{oaa-policy}}/policy/config/property/v1", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Mon, 4 Oct 2021 13:27:00 GMT" }, { "key": "transfer-encoding", "value": "chunked" }, { "key": "connection", "value": "keep-alive" } ], "cookie": [], "body": "[\n {\n \"name\": \"oaa.admin.ui.theme.default.image.path.background\",\n \"value\": \"https://www.example.com/content/images/background.jpg\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.image.path.favicon\",\n \"value\": \"https://www.example.com/content/images/favicon.jpg\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.font.text.header\",\n \"value\": \"Example Company Advanced Authentication\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.font.color.header\",\n \"value\": \"#ffffff\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.font.text.title\",\n \"value\": \"Example Company OAA\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.color\",\n \"value\": \"#00688c\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.color.copyrightNotice\",\n \"value\": \"rgba(22, 21, 19, .6)\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.about\",\n \"value\": \"About Example Company\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.contactus\",\n \"value\": \"Contact us\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.legalnotice\",\n \"value\": \"Legal Notice\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.termsofuse\",\n \"value\": \"Terms of use\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.privacyright\",\n \"value\": \"Privacyright\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.about\",\n \"value\": \"http://www.example.com/us/corporate/index.html#menu-about\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.contactus\",\n \"value\": \"http://www.example.com/us/corporate/contact/index.html\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.legalnotice\",\n \"value\": \"http://www.example.com/us/legal/index.html\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.termsofuse\",\n \"value\": \"http://www.example.com/us/legal/terms/index.html\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.link.privacyright\",\n \"value\": \"http://www.example.com/us/legal/privacy/index.html\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.footer.text.copyrightNotice\",\n \"value\": \"Copyright © 2021, Example Company and/or its affiliates. All rights reserved.\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.image.tiled.background\",\n \"value\": \"false\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.admin.ui.theme.default.font.family\",\n \"value\": \"Oracle Sans\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.image.path.logo\",\n \"value\": \"https://www.example.com/content/images/logo.jpg\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.image.path.background\",\n \"value\": \"https://www.example.com/content/images/background.jpg\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.image.path.favicon\",\n \"value\": \"https://www.example.com/content/images/favicon.jpg\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.font.text.header\",\n \"value\": \"Example Company Advanced Authentication\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.font.color.header\",\n \"value\": \"#ffff00\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.font.text.title\",\n \"value\": \"Example Company User Preferences\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.color\",\n \"value\": \"#00688c\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.color.copyrightNotice\",\n \"value\": \"rgba(22, 21, 19, .6)\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.about\",\n \"value\": \"About Example Company\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.contactus\",\n \"value\": \"Contact us\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.legalnotice\",\n \"value\": \"Legal Notice\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.termsofuse\",\n \"value\": \"Terms of use\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.privacyright\",\n \"value\": \"Privacyright\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.about\",\n \"value\": \"http://www.example.com/us/corporate/index.html#menu-about\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.contactus\",\n \"value\": \"http://www.example.com/us/corporate/contact/index.html\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.legalnotice\",\n \"value\": \"http://www.example.com/us/legal/index.html\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.termsofuse\",\n \"value\": \"http://www.example.com/us/legal/terms/index.html\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.link.privacyright\",\n \"value\": \"http://www.example.com/us/legal/privacy/index.html\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.footer.text.copyrightNotice\",\n \"value\": \"Copyright © 2021, Example Company and/or its affiliates. All rights reserved.\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.image.tiled.background\",\n \"value\": \"false\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.prefs.ui.theme.default.font.family\",\n \"value\": \"Oracle Sans\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.image.path.logo\",\n \"value\": \"https://www.example.com/content/images/logo.jpg\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.image.path.background\",\n \"value\": \"https://www.example.com/content/images/background.jpg\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.image.path.favicon\",\n \"value\": \"https://www.example.com/content/images/favicon.jpg\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.text.title\",\n \"value\": \"Example Company - Advanced Authentication\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.color\",\n \"value\": \"#00688c\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.color.copyrightNotice\",\n \"value\": \"rgba(22, 21, 19, .6)\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.about\",\n \"value\": \"About Example Company\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.contactus\",\n \"value\": \"Contact us\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.legalnotice\",\n \"value\": \"Legal Notice\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.termsofuse\",\n \"value\": \"Terms of use\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.privacyright\",\n \"value\": \"Privacyright\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.about\",\n \"value\": \"http://www.example.com/us/corporate/index.html#menu-about\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.contactus\",\n \"value\": \"http://www.examplecompany.com/us/corporate/contact/index.html\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.legalnotice\",\n \"value\": \"http://www.examplecompany.com/us/legal/index.html\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.termsofuse\",\n \"value\": \"http://www.examplecompany.com/us/legal/terms/index.html\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.link.privacyright\",\n \"value\": \"http://www.examplecompany.com/us/legal/privacy/index.html\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.footer.text.copyrightNotice\",\n \"value\": \"Copyright © 2021, Example Company and/or its affiliates. All rights reserved.\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.family\",\n \"value\": \"Oracle Sans\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.button.color.active\",\n \"value\": \"rgb(79, 105, 63)\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.button.color.hover\",\n \"value\": \"rgb(87, 115, 70)\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.button.color.focus\",\n \"value\": \"rgb(95, 125, 79)\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.image.tiled.background\",\n \"value\": \"false\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.color.factor\",\n \"value\": \"rgb(22, 21, 19)\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.color.factorlink\",\n \"value\": \"#00688c\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.color.label\",\n \"value\": \"rgba(22, 21, 19, .6)\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.rui.ui.theme.default.font.color.header\",\n \"value\": \"rgb(22, 21, 19)\",\n \"source\": \"database\"\n }\n]" } ] }, { "name": "Creates or updates Android PUSH Notification Factor Properties", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyProtocol\",\n\"value\": \"https\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyHost\",\n\"value\": \"proxy.example.com\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyPort\",\n\"value\": \"80\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.google.firebase.serverKey\",\n\"value\": \"AAAAh1hlXa8:APA91bGOGR4pMYe9GC6a2rU169hTCBVmcufvpNUfrOoVgiIQe7x9xEGRq5f7zK3W_IHEVgzPHO1Qt0VJNAYMUdd_PRFvFJd0GZTXN9LpU2F8_Egn7IZguC1Rr2HSNnROzXu1d1Lam0TJ\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.google.firebase.senderId\",\n\"value\": \"581303623087\"\n}\n]" }, "url": { "raw": "{{oaa-policy}}/policy/config/property/v1", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ] }, "description": "Create or update properties for customizing the Android Push Notification Factor" }, "response": [ { "name": "Example Success Respose - Creates or updates Android PUSH Notification Factor Properties", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyProtocol\",\n\"value\": \"https\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyHost\",\n\"value\": \"proxy.example.com\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyPort\",\n\"value\": \"80\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.google.firebase.serverKey\",\n\"value\": \"AAAAh1hlXa8:APA91bGOGR4pMYe9GC6a2rU169hTCBVmcufvpNUfrOoVgiIQe7x9xEGRq5f7zK3W_IHEVgzPHO1Qt0VJNAYMUdd_PRFvFJd0GZTXN9LpU2F8_Egn7IZguC1Rr2HSNnROzXu1d1Lam0TJ\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.google.firebase.senderId\",\n\"value\": \"581303623087\"\n}\n]" }, "url": { "raw": "{{oaa-policy}}/policy/config/property/v1", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 14 Feb 2022 11:24:02 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "769" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" } ], "cookie": [], "body": "[\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyProtocol\",\n \"value\": \"https\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyHost\",\n \"value\": \"proxy.example.com\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyPort\",\n \"value\": \"80\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.google.firebase.serverKey\",\n \"value\": \"AAAAh1hlXa8:APA91bGOGR4pMYe9GC6a2rU169hTCBVmcufvpNUfrOoVgiIQe7x9xEGRq5f7zK3W_IHEVgzPHO1Qt0VJNAYMUdd_PRFvFJd0GZTXN9LpU2F8_Egn7IZguC1Rr2HSNnROzXu1d1Lam0TJ\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.google.firebase.senderId\",\n \"value\": \"581303623087\",\n \"source\": \"database\"\n }\n]" } ] }, { "name": "Creates or updates Apple PUSH Notification Factor Properties", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyProtocol\",\n\"value\": \"https\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyHost\",\n\"value\": \"proxy.example.com\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyPort\",\n\"value\": \"80\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.apns.keystorePath\",\n\"value\": \"/u01/oracle/service/store/oaa/ChallengeOMAPUSH/apns/APNsCertificate.jks\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.apns.keystorePass\",\n\"value\": \"password\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.apns.h2Topic\",\n\"value\": \"com.example.internal.ent2.oma.production\"\n}\n]" }, "url": { "raw": "{{oaa-policy}}/policy/config/property/v1", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ] }, "description": "Create or update properties for customizing the Apple Push Notification Factor." }, "response": [ { "name": "Example Success Response - Creates or updates Apple PUSH Notification Factor Properties", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyProtocol\",\n\"value\": \"https>\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyHost\",\n\"value\": \"proxy.example.com\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyPort\",\n\"value\": \"80\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.apns.keystorePath\",\n\"value\": \"/u01/oracle/service/store/oaa/ChallengeOMAPUSH/apns/APNsCertificate.jks\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.apns.keystorePass\",\n\"value\": \"password\"\n},\n{\n\"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.apns.h2Topic\",\n\"value\": \"com.example.internal.ent2.oma.production\"\n}\n]" }, "url": { "raw": "{{oaa-policy}}/policy/config/property/v1", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 14 Feb 2022 11:25:39 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "822" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" } ], "cookie": [], "body": "[\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyProtocol\",\n \"value\": \"https\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyHost\",\n \"value\": \"proxy.example.com\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.proxyPort\",\n \"value\": \"80\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.apns.keystorePath\",\n \"value\": \"/u01/oracle/service/store/oaa/ChallengeOMAPUSH/apns/APNsCertificate.jks\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.apns.keystorePass\",\n \"value\": \"password\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeOMAPUSH.apns.h2Topic\",\n \"value\": \"com.example.internal.ent2.oma.production\",\n \"source\": \"database\"\n }\n]" } ] }, { "name": "Creates or updates OAA-OARM specific properties", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n{\n\"name\": \"oaa.browser.cookie.domain\",\n\"value\": \"host.example.com\"\n},\n{\n\"name\": \"oaa.risk.integration.postauth.cp\",\n\"value\": \"postauth\"\n},\n{\n\"name\": \"oaa.policy.assurance.level.default.action\",\n\"value\": \"Challenge\"\n},\n{\n\"name\": \"profile.type.enum..riskcheckpoint\",\n\"value\": \"RiskAssuranceLevel2\"\n},\n{\n\"name\": \"profile.type.enum..defaultaction\",\n\"value\": \"Challenge\"\n},\n{\n\"name\": \"rule.action.enum..priority\",\n\"value\": \"max\"\n}\n]" }, "url": { "raw": "{{oaa-policy}}/policy/config/property/v1", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ] }, "description": "Create or update properties for customizing the properties for OAA-OARM install." }, "response": [ { "name": "Example Success Response - Creates or updates OAA-OARM specific properties", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n{\n\"name\": \"oaa.browser.cookie.domain\",\n\"value\": \"host.example.com\"\n},\n{\n\"name\": \"oaa.risk.integration.postauth.cp\",\n\"value\": \"RiskAssuranceLevel1\"\n},\n{\n\"name\": \"oaa.policy.assurance.level.default.action\",\n\"value\": \"Challenge\"\n},\n{\n\"name\": \"profile.type.enum..riskcheckpoint\",\n\"value\": \"RiskAssuranceLevel2\"\n},\n{\n\"name\": \"profile.type.enum..defaultaction\",\n\"value\": \"Challenge\"\n},\n{\n\"name\": \"rule.action.enum..priority\",\n\"value\": \"max\"\n}\n]" }, "url": { "raw": "{{oaa-policy}}/policy/config/property/v1", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Mon, 14 Feb 2022 11:28:33 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "573" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" } ], "cookie": [], "body": "[\n {\n \"name\": \"oaa.browser.cookie.domain\",\n \"value\": \"host.example.com\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.risk.integration.postauth.cp\",\n \"value\": \"RiskAssuranceLevel1\",\n \"source\": \"database\"\n },\n {\n \"name\": \"oaa.policy.assurance.level.default.action\",\n \"value\": \"Challenge\",\n \"source\": \"database\"\n },\n {\n \"name\": \"profile.type.enum..riskcheckpoint\",\n \"value\": \"RiskAssuranceLevel2\",\n \"source\": \"database\"\n },\n {\n \"name\": \"profile.type.enum..defaultaction\",\n \"value\": \"Challenge\",\n \"source\": \"database\"\n },\n {\n \"name\": \"rule.action.enum..priority\",\n \"value\": \"max\",\n \"source\": \"database\"\n }\n]" } ] }, { "name": "Gets configuration properties that are provided in the input", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "saveHelperData", "value": true, "type": "boolean" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/policy/config/property/v1?propertyName=bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ], "query": [ { "key": "propertyName", "value": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress" } ] }, "description": "Returns configuration properties that contain input string in name.\n\nIn Params tab set the \"propertyName\" to the value of the property to fetch." }, "response": [ { "name": "Example Success Response - Gets configuration properties that are provided in the input", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{oaa-policy}}/policy/config/property/v1?propertyName=bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ], "query": [ { "key": "propertyName", "value": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Fri, 5 Mar 2021 11:22:30 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "130" } ], "cookie": [], "body": "[\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress\",\n \"value\": \"security@example.com\",\n \"source\": \"database\"\n }\n]" } ] }, { "name": "Deletes configuration property that is provided in the input", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "saveHelperData", "value": true, "type": "boolean" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{oaa-policy}}/policy/config/property/v1?propertyName=bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ], "query": [ { "key": "propertyName", "value": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate", "description": "(Required) " } ] }, "description": "Delete configuration that is provided.\n\nWhether the property to be deleted exists or not a 200 response is returned. If no config property is provided in the input then this is function does not change anything in config properties, and a 200 response is returned. Returns API Response. API response contains empty array of properties in all cases." }, "response": [ { "name": "Example Success Response - Deletes configuration property that is provided in the input", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{oaa-policy}}/policy/config/property/v1?propertyName=bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ], "query": [ { "key": "propertyName", "value": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Fri, 5 Mar 2021 11:27:57 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "87" } ], "cookie": [], "body": "{\n \"responseCode\": \"200\",\n \"responseMessage\": \"Configuration property successfully deleted.\"\n}" } ] } ] } ], "description": "This API describes configuration properties related operations in OAA.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "REST API for User Preferences", "item": [ { "name": "preferences/v1", "item": [ { "name": "User Preferences are created/registered", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaaapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"user1\",\n \"groupId\": \"Default\",\n \"imageReference\": \"/u01/oracle/service/store/img001.jpg \",\n \"phraseString\": \"Hello World!\",\n \"factorsRegistered\": [\n {\n \"factorAttributes\": [\n {\n \"factorAttributeValue\": [\n {\n \"value\": \"user1@example.com\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ],\n \"factorAttributeName\": \"email\"\n }\n ],\n \"factorKey\": \"ChallengeEmail\",\n \"isPreferred\": false\n },\n {\n \"factorAttributes\": [\n {\n \"factorAttributeValue\": [\n {\n \"value\": \"secret_key\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ],\n \"factorAttributeName\": \"omatotpsecretkey\"\n }\n ],\n \"factorKey\": \"ChallengeOMATOTP\",\n \"isPreferred\": false\n }\n ]\n }" }, "url": { "raw": "{{oaa-runtime}}/oaa/runtime/preferences/v1", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "preferences", "v1" ] }, "description": "User Preferences are created/registered.\n\nIn the Body set \"userId\" and \"groupID\" to desired values for the user to create and the group to add it to.\n\nIn this example \"user1\" is created in \"Default\". The factors registered for the user are Email and OMATOTP.\n\n\"imageReference\" and \"phraseString\" store an image and phrase that can be accessed from the API only. If the \"imageReference\" parameter is passed, the image must be stored in a NFS_PATH that is accessible inside the container. For example \"/u01/oracle/service/store/secureImage01.jpg\" correlates to \"NFS_VAULT_PATH\" inside the container.\n\nFor OMAOTP change \"secret_key\" to a value of your choice.\n\nFor data that is not consistent/complete and error is returned. For users that already exist in the system, and error is returned." }, "response": [ { "name": "Example Success Response - User Preferences are created/registered", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"user1\",\n \"groupId\": \"Default\",\n \"factorsRegistered\": [\n {\n \"factorAttributes\": [\n {\n \"factorAttributeValue\": [\n {\n \"value\": \"user1@example.com\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ],\n \"factorAttributeName\": \"email\"\n }\n ],\n \"factorKey\": \"ChallengeEmail\",\n \"isPreferred\": false\n },\n {\n \"factorAttributes\": [\n {\n \"factorAttributeValue\": [\n {\n \"value\": \"secret_key\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ],\n \"factorAttributeName\": \"omatotpsecretkey\"\n }\n ],\n \"factorKey\": \"ChallengeOMATOTP\",\n \"isPreferred\": false\n }\n ]\n }" }, "url": { "raw": "{{oaa-runtime}}/oaa/runtime/preferences/v1?", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "preferences", "v1" ], "query": [ { "key": "", "value": null } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 13:55:28 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "629" } ], "cookie": [], "body": "{\n \"preferences\": {\n \"userId\": \"user1\",\n \"groupId\": \"Default\",\n \"imageReference\": \"/u01/oracle/service/store/img001.jpg\",\n \"phraseString\": \"Hello World!\",\n \"factorsRegistered\": [\n {\n \"isPreferred\": false,\n \"factorName\": \"Oracle Mobile Authenticator\",\n \"factorKey\": \"ChallengeOMATOTP\",\n \"factorAttributes\": [\n {\n \"factorAttributeName\": \"omatotpsecretkey\",\n \"factorAttributeValue\": [\n {\n \"value\": \"secret_key\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ]\n }\n ]\n },\n {\n \"isPreferred\": false,\n \"factorName\": \"Email Challenge\",\n \"factorKey\": \"ChallengeEmail\",\n \"factorAttributes\": [\n {\n \"factorAttributeName\": \"email\",\n \"factorAttributeValue\": [\n {\n \"value\": \"user1@example.com\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ]\n }\n ]\n }\n ]\n },\n \"message\": {\n \"responseCode\": \"201\",\n \"responseMessage\": \"User preference is created.\"\n }\n}" } ] }, { "name": "Return user's challenge preferences as available in OAA", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaaapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{oaa-runtime}}/oaa/runtime/preferences/v1?userId=user1&groupId=Default", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "preferences", "v1" ], "query": [ { "key": "userId", "value": "user1", "description": "(Required) " }, { "key": "groupId", "value": "Default" } ] }, "description": "Return user's challenge preferences.\n\nReturns a list of challenge preferences for the specified user.\n\nIn the Params tab set the values of \"userId\" and \"groupId\" to return challenge preferences for that user." }, "response": [ { "name": "Example Success Response - Return user's challenge preferences as available in OAA", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{oaa-runtime}}/oaa/runtime/preferences/v1?userId=user1&groupId=Default", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "preferences", "v1" ], "query": [ { "key": "userId", "value": "user1", "description": "(Required) " }, { "key": "groupId", "value": "Default" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 14:00:42 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "532" } ], "cookie": [], "body": "{\n \"userId\": \"user1\",\n \"groupId\": \"Default\",\n \"imageReference\": \"/u01/oracle/service/store/img001.jpg\",\n \"phraseString\": \"Hello World!\",\n \"factorsRegistered\": [\n {\n \"isPreferred\": false,\n \"factorName\": \"Oracle Mobile Authenticator\",\n \"factorKey\": \"ChallengeOMATOTP\",\n \"factorAttributes\": [\n {\n \"factorAttributeName\": \"omatotpsecretkey\",\n \"factorAttributeValue\": [\n {\n \"value\": \"secret_key\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ]\n }\n ]\n },\n {\n \"isPreferred\": false,\n \"factorName\": \"Email Challenge\",\n \"factorKey\": \"ChallengeEmail\",\n \"factorAttributes\": [\n {\n \"factorAttributeName\": \"email\",\n \"factorAttributeValue\": [\n {\n \"value\": \"user1@example.com\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ]\n }\n ]\n }\n ]\n}" } ] }, { "name": "Update User Preferences", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaaapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"user1\",\n \"groupId\": \"Default\",\n \"factorsRegistered\": [\n {\n \"factorAttributes\": [\n {\n \"factorAttributeValue\": [\n {\n \"value\": \"user1@example.com\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ],\n \"factorAttributeName\": \"email\"\n }\n ],\n \"factorKey\": \"ChallengeEmail\",\n \"isPreferred\": false\n },\n {\n \"factorAttributes\": [\n {\n \"factorAttributeValue\": [\n {\n \"value\": \"welcome\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ],\n \"factorAttributeName\": \"omatotpsecretkey\"\n }\n ],\n \"factorKey\": \"ChallengeOMATOTP\",\n \"isPreferred\": false\n },\n {\n \"factorAttributes\": [\n {\n \"factorAttributeValue\": [\n {\n \"value\": \"+123456789000\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ],\n \"factorAttributeName\": \"mobile\"\n }\n ],\n \"factorKey\": \"ChallengeSMS\",\n \"isPreferred\": false\n }\n ]\n }" }, "url": { "raw": "{{oaa-runtime}}/oaa/runtime/preferences/v1", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "preferences", "v1" ] }, "description": "Update user preferences for a given user.\n\nIn this example \"user1\" in \"group1\" preferences are updated to add the SMS factor." }, "response": [ { "name": "Example Success Response - Update User Preferences", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"user1\",\n \"groupId\": \"Default\",\n \"factorsRegistered\": [\n {\n \"factorAttributes\": [\n {\n \"factorAttributeValue\": [\n {\n \"value\": \"user1@example.com\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ],\n \"factorAttributeName\": \"email\"\n }\n ],\n \"factorKey\": \"ChallengeEmail\",\n \"isPreferred\": false\n },\n {\n \"factorAttributes\": [\n {\n \"factorAttributeValue\": [\n {\n \"value\": \"secret_key\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ],\n \"factorAttributeName\": \"omatotpsecretkey\"\n }\n ],\n \"factorKey\": \"ChallengeOMATOTP\",\n \"isPreferred\": false\n },\n {\n \"factorAttributes\": [\n {\n \"factorAttributeValue\": [\n {\n \"value\": \"+123456789000\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ],\n \"factorAttributeName\": \"mobile\"\n }\n ],\n \"factorKey\": \"ChallengeSMS\",\n \"isPreferred\": false\n }\n ]\n }" }, "url": { "raw": "{{oaa-runtime}}/oaa/runtime/preferences/v1", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "preferences", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 1 Apr 2021 14:02:28 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "844" } ], "cookie": [], "body": "{\n \"preferences\": {\n \"userId\": \"user1\",\n \"groupId\": \"Default\",\n \"factorsRegistered\": [\n {\n \"isPreferred\": false,\n \"factorName\": \"Oracle Mobile Authenticator\",\n \"factorKey\": \"ChallengeOMATOTP\",\n \"factorAttributes\": [\n {\n \"factorAttributeName\": \"omatotpsecretkey\",\n \"factorAttributeValue\": [\n {\n \"value\": \"secret_key\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ]\n }\n ]\n },\n {\n \"isPreferred\": false,\n \"factorName\": \"Email Challenge\",\n \"factorKey\": \"ChallengeEmail\",\n \"factorAttributes\": [\n {\n \"factorAttributeName\": \"email\",\n \"factorAttributeValue\": [\n {\n \"value\": \"user1@example.com\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ]\n }\n ]\n },\n {\n \"isPreferred\": false,\n \"factorName\": \"SMS Challenge\",\n \"factorKey\": \"ChallengeSMS\",\n \"factorAttributes\": [\n {\n \"factorAttributeName\": \"mobile\",\n \"factorAttributeValue\": [\n {\n \"value\": \"+123456789000\",\n \"name\": \"Device1\",\n \"isEnabled\": true\n }\n ]\n }\n ]\n }\n ]\n },\n \"message\": {\n \"responseCode\": \"200\",\n \"responseMessage\": \"User Preferences updated.\"\n }\n}" } ] }, { "name": "Delete User Preferences", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaaapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa", "type": "string" } ] }, "method": "DELETE", "header": [], "url": { "raw": "{{oaa-runtime}}/oaa/runtime/preferences/v1?userId=user2&groupId=default", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "preferences", "v1" ], "query": [ { "key": "userId", "value": "user2", "description": "(Required) " }, { "key": "groupId", "value": "default" } ] }, "description": "Delete user preferences. \n\nRemove preferences for a specific user. In the Params tab enter the values for \"userId\" and \"groupId\" for the user whose preferences are to be deleted.\n\nNote - it does not actually remove the user from OAA, only their challenge preferences. \n\nFor user's that have deleted preferences, use \"Update User Preferences\" to set user preferences again." }, "response": [ { "name": "Example Success Response - User Preferences are deleted", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{oaa-runtime}}/oaa/runtime/preferences/v1?userId=user2&groupId=default", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "preferences", "v1" ], "query": [ { "key": "userId", "value": "user2", "description": "(Required) " }, { "key": "groupId", "value": "default" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Mon, 1 Mar 2021 17:13:27 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "63" } ], "cookie": [], "body": "{\n \"responseCode\": \"202\",\n \"responseMessage\": \"Deletion is complete\"\n}" } ] } ] } ], "description": "This API describes user preferences API for users' challenge factors. The preferences data is used for managing challenges for user during authentication flow.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "REST API for KBA", "item": [ { "name": "kba/v1", "item": [ { "name": "Get a KBA Request for a user", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaafactorapikey}}", "type": "string" }, { "key": "username", "value": "{{KBA}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{oaa-runtime}}/oaa-kba/runtime/kba/v1/questions?userid=user1&group=Default", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa-kba", "runtime", "kba", "v1", "questions" ], "query": [ { "key": "userid", "value": "user1" }, { "key": "group", "value": "Default" } ] }, "description": "Get questions associated with a user.\n\nIf user information is present, questions associated with the user are returned. These are questions preselected by the system to be used for KBA challenge.\n\nThe number of questions returned is based on the values \"Questions User Will Register and \"Questions per Menu\" under \"Security Questions\" in the OAA Administration console." }, "response": [ { "name": "Example Success Response - Get a KBA Request for a user", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{oaa-runtime}}/oaa-kba/runtime/kba/v1/questions?userid=user1&group=Default", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa-kba", "runtime", "kba", "v1", "questions" ], "query": [ { "key": "userid", "value": "user1" }, { "key": "group", "value": "Default" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Date", "value": "Thu, 26 Jan 2023 10:33:17 GMT" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Content-Length", "value": "1504" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" } ], "cookie": [], "body": "{\n \"status\": \"0\",\n \"message\": \"Successfully processed the request.\",\n \"choices\": [\n {\n \"questions\": [\n {\n \"questionId\": 2,\n \"question\": \"What was your father's profession when you were born?\",\n \"active\": false\n },\n {\n \"questionId\": 41,\n \"question\": \"What was the last name of your favorite teacher in High School?\",\n \"active\": false\n },\n {\n \"questionId\": 5,\n \"question\": \"What is the first name of your mother's eldest sibling?\",\n \"active\": false\n },\n {\n \"questionId\": 33,\n \"question\": \"How much did you pay for your first car?\",\n \"active\": false\n },\n {\n \"questionId\": 17,\n \"question\": \"What was the first name of your first boss?\",\n \"active\": false\n }\n ]\n },\n {\n \"questions\": [\n {\n \"questionId\": 87,\n \"question\": \"What was the name of your favorite childhood musical group?\",\n \"active\": false\n },\n {\n \"questionId\": 50,\n \"question\": \"What was your youngest child's birth weight?\",\n \"active\": false\n },\n {\n \"questionId\": 126,\n \"question\": \"What year was your favorite Super Bowl?\",\n \"active\": false\n },\n {\n \"questionId\": 23,\n \"question\": \"What was your first sweetheart's first name?\",\n \"active\": false\n },\n {\n \"questionId\": 54,\n \"question\": \"What breed was your first dog?\",\n \"active\": false\n }\n ]\n },\n {\n \"questions\": [\n {\n \"questionId\": 60,\n \"question\": \"What is your best friend's birthday?\",\n \"active\": false\n },\n {\n \"questionId\": 3,\n \"question\": \"What was your birth weight?\",\n \"active\": false\n },\n {\n \"questionId\": 42,\n \"question\": \"What was the last name of your favorite professor in college?\",\n \"active\": false\n },\n {\n \"questionId\": 6,\n \"question\": \"What is your maternal grandfather's first name?\",\n \"active\": false\n },\n {\n \"questionId\": 34,\n \"question\": \"What year did you purchase your first car?\",\n \"active\": false\n }\n ]\n }\n ]\n}" } ] }, { "name": "Update questons with answers for the user", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaafactorapikey}}", "type": "string" }, { "key": "username", "value": "{{KBA}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"userid\": \"user1\",\n \"group\": \"Default\"\n },\n \"choices\": [\n {\n \"questions\": [\n {\n \"questionId\": 2,\n \"question\": \"What was your father's profession when you were born?\",\n \"active\": true,\n \"answer\": \"born\"\n }\n ]\n },\n {\n \"questions\": [\n {\n \"questionId\": 87,\n \"question\": \"What was the name of your favorite childhood musical group?\",\n \"active\": true,\n \"answer\": \"group\"\n }\n ]\n },\n {\n \"questions\": [\n {\n \"questionId\": 60,\n \"question\": \"What is your best friend's birthday?\",\n \"active\": true,\n \"answer\": \"birthday\"\n }\n ]\n \n }\n ]\n}\n" }, "url": { "raw": "{{oaa-runtime}}/oaa-kba/runtime/kba/v1/questions", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa-kba", "runtime", "kba", "v1", "questions" ] }, "description": "Answer questions returned in the previous GET request for a user.\n\nThe user is challenged with the active questions. Questions associated with users will be used during authentication to verify the user's identity. The answers provided are stored as the user private answer for the question. The user identity data must be present in the body of the PUT request. The user associations as well as the user answers with the provided questions alone will be updated. When the Active flag is true, the question may be used to challenge the user.\n\nIn this example, user1 updates answers to three questions, one in each of the set of questions returned. \n\nTo set the question and answer, \"active\" is set to \"true\" and the \"answer\" is given.\n\nIf successful a \"204 No Content\" is returned.\n\nIf another GET is then performed, those questions set will show \"active:true\".\n\nFrom now on, when a user authenticates and is challenged for a Security Question, one of these questions will be returned. The user responds with the answers set here." }, "response": [ { "name": "Example Success Response - Update questons with answers for the user", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"user\": {\n \"userid\": \"user1\",\n \"group\": \"Default\"\n },\n \"choices\": [\n {\n \"questions\": [\n {\n \"questionId\": 2,\n \"question\": \"What was your father's profession when you were born?\",\n \"active\": true,\n \"answer\": \"born\"\n }\n ]\n },\n {\n \"questions\": [\n {\n \"questionId\": 87,\n \"question\": \"What was the name of your favorite childhood musical group?\",\n \"active\": true,\n \"answer\": \"group\"\n }\n ]\n },\n {\n \"questions\": [\n {\n \"questionId\": 60,\n \"question\": \"What is your best friend's birthday?\",\n \"active\": true,\n \"answer\": \"birthday\"\n }\n ]\n \n }\n ]\n}\n" }, "url": { "raw": "{{oaa-runtime}}/oaa-kba/runtime/kba/v1/questions", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa-kba", "runtime", "kba", "v1", "questions" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "plain", "header": [ { "key": "Date", "value": "Fri, 20 Jan 2023 11:54:05 GMT" }, { "key": "Connection", "value": "keep-alive" }, { "key": "Strict-Transport-Security", "value": "max-age=15724800; includeSubDomains" } ], "cookie": [], "body": null } ] } ] } ], "description": "This API describes user preferences API for users' challenge factors. The preferences data is used for managing challenges for user during authentication flow.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "REST API for User Challenge", "item": [ { "name": "authn/v1", "item": [ { "name": "Challenge User, Initialize Challenge, Validate Challenge", "item": [ { "name": "Challenge User", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaaapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userInfo\": {\n \"userId\": \"user1\",\n \"groups\": [\n \"Default\"\n ]\n },\n \"clientInfo\": {\n \"ctype\": \"API\",\n \"clientSecret\": \"b2484989-5f42-4ad8-b0ab-7bbaa06ee786\",\n \"clientId\": \"c1e08e6a-b555-47e1-84a5-36edd06fbf57\"\n },\n \"context\": {\n \"assuranceLevel\": \"AssuranceLevel1\",\n \"customContext\": {\n \"ipAddr\": \"198.51.100.2\"\n }\n },\n \"timeToLiveInSec\": 300\n}" }, "url": { "raw": "{{oaa-runtime}}/oaa/runtime/authn/v1", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "authn", "v1" ] }, "description": "Challenge the User\n\nIn this example a request is sent to challenge user1 against the API agent created in \"Create API Agent\" and the associated assurance level \"AssuranceLevel1\". \n\nThe \"clientId\" and \"clientSecret\" of the agent are passed in the request along with the name of the AssuranceLevel to validate the user against.\n\nAs there is a policy and rule defined against AssuranceLevel1 to return the factors in \"FactorGroup1\" if the IP address is in the \"SecureIPRange\" group, then the \"ipAddr\" is passed where the IP is within that secure range.\n\nIn the response the factors are returned that user1 has defined (OMAOTP and Email), along with the following indicating authentication is required.\n\n{\n \"apiResponse\": {\n \"code\": \"OAA-40001\",\n \"status\": \"Pending\",\n \"message\": \"Authentication Required\"\n }\n\nMake note of the \"correlationId\" as this is required in the subsequent Initialize request." }, "response": [ { "name": "Example Success Response - Challenge User", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userInfo\": {\n \"userId\": \"user1\",\n \"groups\": [\n \"Default\"\n ]\n },\n \"clientInfo\": {\n \"ctype\": \"API\",\n \"clientSecret\": \"b2484989-5f42-4ad8-b0ab-7bbaa06ee786\",\n \"clientId\": \"c1e08e6a-b555-47e1-84a5-36edd06fbf57\"\n },\n \"context\": {\n \"assuranceLevel\": \"AssuranceLevel1\",\n \"customContext\": {\n \"ipAddr\": \"198.51.100.2\"\n }\n },\n \"timeToLiveInSec\": 300\n}" }, "url": { "raw": "{{oaa-runtime}}/oaa/runtime/authn/v1", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "authn", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 22 Apr 2021 08:35:06 GMT" }, { "key": "transfer-encoding", "value": "chunked" }, { "key": "connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"apiResponse\": {\n \"code\": \"OAA-40001\",\n \"status\": \"Pending\",\n \"message\": \"Authentication Required\"\n },\n \"correlationId\": \"79_e76d638f0c0af6c9903a86e1d1d42722471e68ed1522b334ed41da8dbcf07e24\",\n \"challengeselectiontext\": \"Choose a method to login.\",\n \"challengeInfo\": [\n {\n \"displayOrder\": 1,\n \"factorName\": \"Email Challenge\",\n \"factorKey\": \"ChallengeEmail\",\n \"factorContext\": {\n \"prompts\": [\n {\n \"prompttext\": \"Send OTP to ru*************@******.com\",\n \"prompt\": \"ru*************@******.com\",\n \"challengeText\": \"Enter OTP sent to ru*************@******.com.\",\n \"requiredInputType\": \"text\",\n \"name\": \"Device1\"\n }\n ],\n \"isSelected\": false,\n \"challengeAttrMap\": [\n {\n \"factorAttributeName\": \"retrycount\",\n \"factorAttributeValue\": \"10\"\n },\n {\n \"factorAttributeName\": \"factorGenerateEndpoint\",\n \"factorAttributeValue\": \"generateChallenge/v1\"\n },\n {\n \"factorAttributeName\": \"otpChars\",\n \"factorAttributeValue\": \"1234567890\"\n },\n {\n \"factorAttributeName\": \"msgIPTemplate\",\n \"factorAttributeValue\": \"IP Address:\"\n },\n {\n \"factorAttributeName\": \"otpexpirytimeMs\",\n \"factorAttributeValue\": \"300000\"\n },\n {\n \"factorAttributeName\": \"available\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"umsPolicyStr\",\n \"factorAttributeValue\": \"\"\n },\n {\n \"factorAttributeName\": \"requiredInfo\",\n \"factorAttributeValue\": \"email\"\n },\n {\n \"factorAttributeName\": \"umsClientURL\",\n \"factorAttributeValue\": \"http://10.184.36.124:8001/ucs/messaging/webservice\"\n },\n {\n \"factorAttributeName\": \"type\",\n \"factorAttributeValue\": \"email\"\n },\n {\n \"factorAttributeName\": \"htmlLabel\",\n \"factorAttributeValue\": \"Email Code\"\n },\n {\n \"factorAttributeName\": \"isverified\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"otpLength\",\n \"factorAttributeValue\": \"6\"\n },\n {\n \"factorAttributeName\": \"customizedProvider\",\n \"factorAttributeValue\": \"\"\n },\n {\n \"factorAttributeName\": \"msgSubject\",\n \"factorAttributeValue\": \"One Time PIN: OAA\"\n },\n {\n \"factorAttributeName\": \"fromName\",\n \"factorAttributeValue\": \"OAA\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.placeholder\",\n \"factorAttributeValue\": \"Enter OTP\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.verifyButtonMessage\",\n \"factorAttributeValue\": \"Verify\"\n },\n {\n \"factorAttributeName\": \"maxRegistrations\",\n \"factorAttributeValue\": \"5\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.label\",\n \"factorAttributeValue\": \"Enter OTP from the registered email %SelectedPrompt%\"\n },\n {\n \"factorAttributeName\": \"availableforpreferencesui\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"isenabled\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"image\",\n \"factorAttributeValue\": \"images/email.png\"\n },\n {\n \"factorAttributeName\": \"adddesc\",\n \"factorAttributeValue\": \"Add email factor\"\n },\n {\n \"factorAttributeName\": \"ignoreresync\",\n \"factorAttributeValue\": \"false\"\n },\n {\n \"factorAttributeName\": \"challengeText\",\n \"factorAttributeValue\": \"Enter OTP sent to {0}.\"\n },\n {\n \"factorAttributeName\": \"maskregexp\",\n \"factorAttributeValue\": \".{1,2}(.*)@([a-zA-Z_]+)?\\\\.[a-zA-Z]{2,3}\"\n },\n {\n \"factorAttributeName\": \"otp\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"processor\",\n \"factorAttributeValue\": \"oracle.security.uas.core.uio.processor.challenge.EmailUMSOTPChallengeProcessor\"\n },\n {\n \"factorAttributeName\": \"maskchar\",\n \"factorAttributeValue\": \"*\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.incorrectOtpMessage\",\n \"factorAttributeValue\": \"Entered OTP is incorrect.\"\n },\n {\n \"factorAttributeName\": \"ldapalias.email\",\n \"factorAttributeValue\": \"mail\"\n },\n {\n \"factorAttributeName\": \"addemail\",\n \"factorAttributeValue\": \"Email\"\n },\n {\n \"factorAttributeName\": \"availableforpreferencesuireg\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"promptselectmessage\",\n \"factorAttributeValue\": \"Please select one of following addresses to receive OTP.\"\n },\n {\n \"factorAttributeName\": \"msgPinTemplate\",\n \"factorAttributeValue\": \"Please use following one time pin to login to the protected resource:\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.clickHereMessage\",\n \"factorAttributeValue\": \"Click Here\"\n },\n {\n \"factorAttributeName\": \"ispreferred\",\n \"factorAttributeValue\": \"false\"\n },\n {\n \"factorAttributeName\": \"msgTimeTemplate\",\n \"factorAttributeValue\": \"Resource URL Access:\"\n },\n {\n \"factorAttributeName\": \"msgType\",\n \"factorAttributeValue\": \"text/plain; charset=UTF-8\"\n },\n {\n \"factorAttributeName\": \"scheme\",\n \"factorAttributeValue\": \"https\"\n },\n {\n \"factorAttributeName\": \"msgResourceURLTemplate\",\n \"factorAttributeValue\": \"Resource URL Access:\"\n },\n {\n \"factorAttributeName\": \"displayedInfo\",\n \"factorAttributeValue\": \"email\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.cancelMessage\",\n \"factorAttributeValue\": \"Return to All Options\"\n },\n {\n \"factorAttributeName\": \"senderSpecificProperties\",\n \"factorAttributeValue\": \"otpexpirytimeMs,msgSubject,msgType,msgPinTemplate,msgTimeTemplate,msgIPTemplate,msgResourceURLTemplate,fromName,appName\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.formSubmitActionPath\",\n \"factorAttributeValue\": \"/oaa-email-factor/login/v1\"\n },\n {\n \"factorAttributeName\": \"factorEndpoint\",\n \"factorAttributeValue\": \"oaa-email-factor/runtime\"\n },\n {\n \"factorAttributeName\": \"enabled\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"challengeCounterExpiryTime\",\n \"factorAttributeValue\": \"180000\"\n },\n {\n \"factorAttributeName\": \"default\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.fields\",\n \"factorAttributeValue\": \"field1\"\n },\n {\n \"factorAttributeName\": \"fromAddress\",\n \"factorAttributeValue\": \"oaa@oracle.com\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.factorHeading\",\n \"factorAttributeValue\": \"Email\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.fieldType\",\n \"factorAttributeValue\": \"inputText\"\n },\n {\n \"factorAttributeName\": \"promptmessage\",\n \"factorAttributeValue\": \"Send OTP to {0}\"\n },\n {\n \"factorAttributeName\": \"addemailhint\",\n \"factorAttributeValue\": \"Enter an email\"\n },\n {\n \"factorAttributeName\": \"msgPinPlaceHolder\",\n \"factorAttributeValue\": \"@@\"\n },\n {\n \"factorAttributeName\": \"factorBrowserEndpoint\",\n \"factorAttributeValue\": \"oaa-email-factor/pages/login.jsp\"\n },\n {\n \"factorAttributeName\": \"appName\",\n \"factorAttributeValue\": \"OAA\"\n },\n {\n \"factorAttributeName\": \"addheader\",\n \"factorAttributeValue\": \"Add Email\"\n },\n {\n \"factorAttributeName\": \"loginpage\",\n \"factorAttributeValue\": \"rui/\"\n },\n {\n \"factorAttributeName\": \"passive\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"factorValidateEndpoint\",\n \"factorAttributeValue\": \"validateChallenge/v1\"\n },\n {\n \"factorAttributeName\": \"umsClientPass\",\n \"factorAttributeValue\": \"Welcome1\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.fieldId\",\n \"factorAttributeValue\": \"otpValue\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.signInAsDifferentUserMessage\",\n \"factorAttributeValue\": \"Not %USERID%?\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.required\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"umsClientName\",\n \"factorAttributeValue\": \"umsuser\"\n },\n {\n \"factorAttributeName\": \"htmlInputType\",\n \"factorAttributeValue\": \"text\"\n }\n ]\n }\n },\n {\n \"displayOrder\": 2,\n \"factorName\": \"Oracle Mobile Authenticator\",\n \"factorKey\": \"ChallengeOMATOTP\",\n \"factorContext\": {\n \"prompts\": [\n {\n \"prompttext\": \"Enter OTP from registered phone\",\n \"prompt\": \"O**************=\",\n \"challengeText\": \"Enter OTP from device Device1\",\n \"requiredInputType\": \"text\",\n \"name\": \"Device1\"\n }\n ],\n \"isSelected\": false,\n \"challengeAttrMap\": [\n {\n \"factorAttributeName\": \"PIN_EXPIRY\",\n \"factorAttributeValue\": \"300000\"\n },\n {\n \"factorAttributeName\": \"retrycount\",\n \"factorAttributeValue\": \"10\"\n },\n {\n \"factorAttributeName\": \"defaultimplementation\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"factorGenerateEndpoint\",\n \"factorAttributeValue\": \"generateChallenge/v1\"\n },\n {\n \"factorAttributeName\": \"otpexpirytimeMs\",\n \"factorAttributeValue\": \"300000\"\n },\n {\n \"factorAttributeName\": \"available\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"pinOnExpiryIncFailureCounter\",\n \"factorAttributeValue\": \"false\"\n },\n {\n \"factorAttributeName\": \"requiredInfo\",\n \"factorAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"factorAttributeName\": \"type\",\n \"factorAttributeValue\": \"totp\"\n },\n {\n \"factorAttributeName\": \"htmlLabel\",\n \"factorAttributeValue\": \"OMA TOTP Code\"\n },\n {\n \"factorAttributeName\": \"isverified\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"otpLength\",\n \"factorAttributeValue\": \"6\"\n },\n {\n \"factorAttributeName\": \"windowSize\",\n \"factorAttributeValue\": \"3\"\n },\n {\n \"factorAttributeName\": \"OTP_TIME_STEP_SIZE\",\n \"factorAttributeValue\": \"30\"\n },\n {\n \"factorAttributeName\": \"encyptKey\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.placeholder\",\n \"factorAttributeValue\": \"Enter OTP\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.verifyButtonMessage\",\n \"factorAttributeValue\": \"Verify\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.label\",\n \"factorAttributeValue\": \"Enter OTP from the registered phone %SelectedPrompt%\"\n },\n {\n \"factorAttributeName\": \"maxRegistrations\",\n \"factorAttributeValue\": \"5\"\n },\n {\n \"factorAttributeName\": \"availableforpreferencesui\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"isenabled\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"image\",\n \"factorAttributeValue\": \"images/totp.png\"\n },\n {\n \"factorAttributeName\": \"adddesc\",\n \"factorAttributeValue\": \"Add security key for Oracle Mobile Authenticator\"\n },\n {\n \"factorAttributeName\": \"ignoreresync\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"challengeText\",\n \"factorAttributeValue\": \"Enter OTP from device {1}\"\n },\n {\n \"factorAttributeName\": \"maskregexp\",\n \"factorAttributeValue\": \"\\\\d{1,2}\\\\D?\\\\D?(\\\\d{3})\\\\D?\\\\D?(\\\\d{3})\\\\D?(\\\\d{2})\\\\d{2}\"\n },\n {\n \"factorAttributeName\": \"addkey\",\n \"factorAttributeValue\": \"Key\"\n },\n {\n \"factorAttributeName\": \"otp\",\n \"factorAttributeValue\": \"false\"\n },\n {\n \"factorAttributeName\": \"otpTimeSkew\",\n \"factorAttributeValue\": \"5\"\n },\n {\n \"factorAttributeName\": \"processor\",\n \"factorAttributeValue\": \"oracle.security.uas.core.uio.processor.challenge.SMSUMSOTPChallengeProcessor\"\n },\n {\n \"factorAttributeName\": \"maskchar\",\n \"factorAttributeValue\": \"*\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.incorrectOtpMessage\",\n \"factorAttributeValue\": \"Entered OTP is incorrect.\"\n },\n {\n \"factorAttributeName\": \"maxAttempts\",\n \"factorAttributeValue\": \"0\"\n },\n {\n \"factorAttributeName\": \"promptselectmessage\",\n \"factorAttributeValue\": \"Please select one of following channels\"\n },\n {\n \"factorAttributeName\": \"availableforpreferencesuireg\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.clickHereMessage\",\n \"factorAttributeValue\": \"Click Here\"\n },\n {\n \"factorAttributeName\": \"ispreferred\",\n \"factorAttributeValue\": \"false\"\n },\n {\n \"factorAttributeName\": \"scheme\",\n \"factorAttributeValue\": \"https\"\n },\n {\n \"factorAttributeName\": \"displayedInfo\",\n \"factorAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"factorAttributeName\": \"HMAC\",\n \"factorAttributeValue\": \"HmacSHA1\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.cancelMessage\",\n \"factorAttributeValue\": \"Return to All Options\"\n },\n {\n \"factorAttributeName\": \"OTP_PAIR_SEP\",\n \"factorAttributeValue\": \"=\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.formSubmitActionPath\",\n \"factorAttributeValue\": \"/oaa-totp-factor/login/v1\"\n },\n {\n \"factorAttributeName\": \"enabled\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"factorEndpoint\",\n \"factorAttributeValue\": \"oaa-totp-factor/runtime\"\n },\n {\n \"factorAttributeName\": \"challengeCounterExpiryTime\",\n \"factorAttributeValue\": \"180000\"\n },\n {\n \"factorAttributeName\": \"default\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.fields\",\n \"factorAttributeValue\": \"field1\"\n },\n {\n \"factorAttributeName\": \"addkeyhint\",\n \"factorAttributeValue\": \"Enter an alphanumeric key\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.factorHeading\",\n \"factorAttributeValue\": \"TOTP\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.fieldType\",\n \"factorAttributeValue\": \"inputText\"\n },\n {\n \"factorAttributeName\": \"promptmessage\",\n \"factorAttributeValue\": \"Enter OTP from registered phone\"\n },\n {\n \"factorAttributeName\": \"factorBrowserEndpoint\",\n \"factorAttributeValue\": \"oaa-totp-factor/pages/login.jsp\"\n },\n {\n \"factorAttributeName\": \"addheader\",\n \"factorAttributeValue\": \"Add Oracle Mobile Authenticator\"\n },\n {\n \"factorAttributeName\": \"loginpage\",\n \"factorAttributeValue\": \"rui/\"\n },\n {\n \"factorAttributeName\": \"ldapalias.omatotpsecretkey\",\n \"factorAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"factorAttributeName\": \"passive\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"factorValidateEndpoint\",\n \"factorAttributeValue\": \"validateChallenge/v1\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.fieldId\",\n \"factorAttributeValue\": \"otpValue\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.signInAsDifferentUserMessage\",\n \"factorAttributeValue\": \"Not %USERID%?\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.required\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"autogeneratefields\",\n \"factorAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"factorAttributeName\": \"htmlInputType\",\n \"factorAttributeValue\": \"text\"\n },\n {\n \"factorAttributeName\": \"OTP_SEP\",\n \"factorAttributeValue\": \";\"\n }\n ]\n }\n }\n ]\n}" } ] }, { "name": "Initialize Challenge", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaaapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"correlationId\": \"79_e76d638f0c0af6c9903a86e1d1d42722471e68ed1522b334ed41da8dbcf07e24\",\n \"challengeop\": \"Init\",\n \"challengedata\": {\n \"userId\": \"user1\",\n \"groupId\": \"Default\",\n \"factorKey\": \"ChallengeOMATOTP\",\n \"successURL\": \"https://www.oracle.com/index.html\",\n \"failureURL\": \"https://www.google.com\"\n }\n}" }, "url": { "raw": "{{oaa-runtime}}/oaa/runtime/authn/v1", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "authn", "v1" ] }, "description": "Initialize the Challenge.\n\nIn this example a request is made to initialize the OMATOTP factor (\"factorKey\": \"ChallengeOMAOTP\".\n\nThe \"correlationId\" returned in the \"Challenge User\" response is passed, along with the \"userId\" and \"group\" for \"user1\".\n\nAny value \"successURL\" and \"failureURL\" can be passed.\n\nIn the response the following is returned indicating that authentication is required for OMAOTP. A \"nonce\" value is returned and this value along with the \"correlationId\" is required in \"Validate Challenge\":\n\n{\n \"apiResponse\": {\n \"code\": \"OAA-40001\",\n \"status\": \"Pending\",\n \"message\": \"Authentication Required\"\n },\n \"correlationId\": \"79_e76d638f0c0af6c9903a86e1d1d42722471e68ed1522b334ed41da8dbcf07e24\",\n \"nonce\": \"76d14025-8b23-4c11-9a2f-f4d050248e20\",\n \"challengecontext\": {\n \"factorKey\": \"ChallengeOMATOTP\",\n etc..." }, "response": [ { "name": "Example Success Response - Initialize Challenge", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"correlationId\": \"79_e76d638f0c0af6c9903a86e1d1d42722471e68ed1522b334ed41da8dbcf07e24\",\n \"challengeop\": \"Init\",\n \"challengedata\": {\n \"userId\": \"user1\",\n \"groupId\": \"Default\",\n \"factorKey\": \"ChallengeOMATOTP\",\n \"successURL\": \"https://www.oracle.com/index.html\",\n \"failureURL\": \"https://www.google.com\"\n }\n}" }, "url": { "raw": "{{oaa-runtime}}/oaa/runtime/authn/v1", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "authn", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 22 Apr 2021 08:35:36 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "5693" } ], "cookie": [], "body": "{\n \"apiResponse\": {\n \"code\": \"OAA-40001\",\n \"status\": \"Pending\",\n \"message\": \"Authentication Required\"\n },\n \"correlationId\": \"79_e76d638f0c0af6c9903a86e1d1d42722471e68ed1522b334ed41da8dbcf07e24\",\n \"nonce\": \"76d14025-8b23-4c11-9a2f-f4d050248e20\",\n \"challengecontext\": {\n \"factorKey\": \"ChallengeOMATOTP\",\n \"successURL\": \"https://www.oracle.com/index.html\",\n \"failureURL\": \"https://www.google.com\",\n \"timeToLiveInSec\": 300,\n \"factorAttributes\": [\n {\n \"userAttributeName\": \"PIN_EXPIRY\",\n \"userAttributeValue\": \"300000\"\n },\n {\n \"userAttributeName\": \"retrycount\",\n \"userAttributeValue\": \"10\"\n },\n {\n \"userAttributeName\": \"defaultimplementation\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"factorGenerateEndpoint\",\n \"userAttributeValue\": \"generateChallenge/v1\"\n },\n {\n \"userAttributeName\": \"otpexpirytimeMs\",\n \"userAttributeValue\": \"300000\"\n },\n {\n \"userAttributeName\": \"available\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"pinOnExpiryIncFailureCounter\",\n \"userAttributeValue\": \"false\"\n },\n {\n \"userAttributeName\": \"requiredInfo\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"type\",\n \"userAttributeValue\": \"totp\"\n },\n {\n \"userAttributeName\": \"htmlLabel\",\n \"userAttributeValue\": \"OMA TOTP Code\"\n },\n {\n \"userAttributeName\": \"isverified\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"otpLength\",\n \"userAttributeValue\": \"6\"\n },\n {\n \"userAttributeName\": \"windowSize\",\n \"userAttributeValue\": \"3\"\n },\n {\n \"userAttributeName\": \"OTP_TIME_STEP_SIZE\",\n \"userAttributeValue\": \"30\"\n },\n {\n \"userAttributeName\": \"encyptKey\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.placeholder\",\n \"userAttributeValue\": \"Enter OTP\"\n },\n {\n \"userAttributeName\": \"runtime.ui.verifyButtonMessage\",\n \"userAttributeValue\": \"Verify\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.label\",\n \"userAttributeValue\": \"Enter OTP from the registered phone %SelectedPrompt%\"\n },\n {\n \"userAttributeName\": \"maxRegistrations\",\n \"userAttributeValue\": \"5\"\n },\n {\n \"userAttributeName\": \"availableforpreferencesui\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"isenabled\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"image\",\n \"userAttributeValue\": \"images/totp.png\"\n },\n {\n \"userAttributeName\": \"adddesc\",\n \"userAttributeValue\": \"Add security key for Oracle Mobile Authenticator\"\n },\n {\n \"userAttributeName\": \"ignoreresync\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"challengeText\",\n \"userAttributeValue\": \"Enter OTP from device {1}\"\n },\n {\n \"userAttributeName\": \"maskregexp\",\n \"userAttributeValue\": \"\\\\d{1,2}\\\\D?\\\\D?(\\\\d{3})\\\\D?\\\\D?(\\\\d{3})\\\\D?(\\\\d{2})\\\\d{2}\"\n },\n {\n \"userAttributeName\": \"addkey\",\n \"userAttributeValue\": \"Key\"\n },\n {\n \"userAttributeName\": \"otp\",\n \"userAttributeValue\": \"false\"\n },\n {\n \"userAttributeName\": \"otpTimeSkew\",\n \"userAttributeValue\": \"5\"\n },\n {\n \"userAttributeName\": \"processor\",\n \"userAttributeValue\": \"oracle.security.uas.core.uio.processor.challenge.SMSUMSOTPChallengeProcessor\"\n },\n {\n \"userAttributeName\": \"maskchar\",\n \"userAttributeValue\": \"*\"\n },\n {\n \"userAttributeName\": \"runtime.ui.incorrectOtpMessage\",\n \"userAttributeValue\": \"Entered OTP is incorrect.\"\n },\n {\n \"userAttributeName\": \"maxAttempts\",\n \"userAttributeValue\": \"0\"\n },\n {\n \"userAttributeName\": \"validationToken\",\n \"userAttributeValue\": \"user1161908053645379_e76d638f0c0af6c9903a86e1d1d42722471e68ed1522b334ed41da8dbcf07e24\"\n },\n {\n \"userAttributeName\": \"promptselectmessage\",\n \"userAttributeValue\": \"Please select one of following channels\"\n },\n {\n \"userAttributeName\": \"availableforpreferencesuireg\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"runtime.ui.clickHereMessage\",\n \"userAttributeValue\": \"Click Here\"\n },\n {\n \"userAttributeName\": \"ispreferred\",\n \"userAttributeValue\": \"false\"\n },\n {\n \"userAttributeName\": \"generatedChallenge\",\n \"userAttributeValue\": \"665159\"\n },\n {\n \"userAttributeName\": \"scheme\",\n \"userAttributeValue\": \"https\"\n },\n {\n \"userAttributeName\": \"displayedInfo\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"HMAC\",\n \"userAttributeValue\": \"HmacSHA1\"\n },\n {\n \"userAttributeName\": \"runtime.ui.cancelMessage\",\n \"userAttributeValue\": \"Return to All Options\"\n },\n {\n \"userAttributeName\": \"OTP_PAIR_SEP\",\n \"userAttributeValue\": \"=\"\n },\n {\n \"userAttributeName\": \"runtime.ui.formSubmitActionPath\",\n \"userAttributeValue\": \"/oaa-totp-factor/login/v1\"\n },\n {\n \"userAttributeName\": \"enabled\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"factorEndpoint\",\n \"userAttributeValue\": \"oaa-totp-factor/runtime\"\n },\n {\n \"userAttributeName\": \"challengeCounterExpiryTime\",\n \"userAttributeValue\": \"180000\"\n },\n {\n \"userAttributeName\": \"default\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"runtime.ui.fields\",\n \"userAttributeValue\": \"field1\"\n },\n {\n \"userAttributeName\": \"addkeyhint\",\n \"userAttributeValue\": \"Enter an alphanumeric key\"\n },\n {\n \"userAttributeName\": \"runtime.ui.factorHeading\",\n \"userAttributeValue\": \"TOTP\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.fieldType\",\n \"userAttributeValue\": \"inputText\"\n },\n {\n \"userAttributeName\": \"promptmessage\",\n \"userAttributeValue\": \"Enter OTP from registered phone\"\n },\n {\n \"userAttributeName\": \"factorBrowserEndpoint\",\n \"userAttributeValue\": \"oaa-totp-factor/pages/login.jsp\"\n },\n {\n \"userAttributeName\": \"addheader\",\n \"userAttributeValue\": \"Add Oracle Mobile Authenticator\"\n },\n {\n \"userAttributeName\": \"loginpage\",\n \"userAttributeValue\": \"rui/\"\n },\n {\n \"userAttributeName\": \"ldapalias.omatotpsecretkey\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"passive\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"factorValidateEndpoint\",\n \"userAttributeValue\": \"validateChallenge/v1\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.fieldId\",\n \"userAttributeValue\": \"otpValue\"\n },\n {\n \"userAttributeName\": \"runtime.ui.signInAsDifferentUserMessage\",\n \"userAttributeValue\": \"Not %USERID%?\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.required\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"autogeneratefields\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"htmlInputType\",\n \"userAttributeValue\": \"text\"\n },\n {\n \"userAttributeName\": \"OTP_SEP\",\n \"userAttributeValue\": \";\"\n }\n ],\n \"requestParams\": [\n {\n \"key\": \"AssertionLevel\",\n \"value\": \"AssuranceLevel1\"\n }\n ],\n \"userId\": \"user1\",\n \"groupId\": \"Default\"\n }\n}" } ] }, { "name": "Validate Challenge", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaaapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"correlationId\": \"79_e76d638f0c0af6c9903a86e1d1d42722471e68ed1522b334ed41da8dbcf07e24\",\n \"challengeop\": \"Validate\",\n \"challengeAnswer\" : \"830002\",\n \"nonce\": \"76d14025-8b23-4c11-9a2f-f4d050248e20\"\n}" }, "url": { "raw": "{{oaa-runtime}}/oaa/runtime/authn/v1", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "authn", "v1" ] }, "description": "Validate the Challenge.\n\nIn this example the challenge for user1 is validated. The \"correlationId\" and \"nonce\" returned in the previous \"Initialize Challenge\" request are passed as parameters, along with a valid OTP code from OMA.\n\nIf the OMATOTP code is validated successfully the response shows an ORA-40004 Authentication Success message." }, "response": [ { "name": "Example Success Response - Validate Challenge", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"correlationId\": \"79_e76d638f0c0af6c9903a86e1d1d42722471e68ed1522b334ed41da8dbcf07e24\",\n \"challengeop\": \"Validate\",\n \"challengeAnswer\" : \"830002\",\n \"nonce\": \"76d14025-8b23-4c11-9a2f-f4d050248e20\"\n}" }, "url": { "raw": "{{oaa-runtime}}/oaa/runtime/authn/v1", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "authn", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 22 Apr 2021 08:36:35 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "5698" } ], "cookie": [], "body": "{\n \"apiResponse\": {\n \"code\": \"OAA-40004\",\n \"status\": \"Authenticated\",\n \"message\": \"Authentication Success\"\n },\n \"correlationId\": \"79_e76d638f0c0af6c9903a86e1d1d42722471e68ed1522b334ed41da8dbcf07e24\",\n \"nonce\": \"76d14025-8b23-4c11-9a2f-f4d050248e20\",\n \"challengecontext\": {\n \"factorKey\": \"ChallengeOMATOTP\",\n \"successURL\": \"https://www.oracle.com/index.html\",\n \"failureURL\": \"https://www.google.com\",\n \"timeToLiveInSec\": 300,\n \"factorAttributes\": [\n {\n \"userAttributeName\": \"PIN_EXPIRY\",\n \"userAttributeValue\": \"300000\"\n },\n {\n \"userAttributeName\": \"retrycount\",\n \"userAttributeValue\": \"10\"\n },\n {\n \"userAttributeName\": \"defaultimplementation\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"factorGenerateEndpoint\",\n \"userAttributeValue\": \"generateChallenge/v1\"\n },\n {\n \"userAttributeName\": \"otpexpirytimeMs\",\n \"userAttributeValue\": \"300000\"\n },\n {\n \"userAttributeName\": \"available\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"pinOnExpiryIncFailureCounter\",\n \"userAttributeValue\": \"false\"\n },\n {\n \"userAttributeName\": \"requiredInfo\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"type\",\n \"userAttributeValue\": \"totp\"\n },\n {\n \"userAttributeName\": \"htmlLabel\",\n \"userAttributeValue\": \"OMA TOTP Code\"\n },\n {\n \"userAttributeName\": \"isverified\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"otpLength\",\n \"userAttributeValue\": \"6\"\n },\n {\n \"userAttributeName\": \"windowSize\",\n \"userAttributeValue\": \"3\"\n },\n {\n \"userAttributeName\": \"OTP_TIME_STEP_SIZE\",\n \"userAttributeValue\": \"30\"\n },\n {\n \"userAttributeName\": \"encyptKey\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.placeholder\",\n \"userAttributeValue\": \"Enter OTP\"\n },\n {\n \"userAttributeName\": \"runtime.ui.verifyButtonMessage\",\n \"userAttributeValue\": \"Verify\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.label\",\n \"userAttributeValue\": \"Enter OTP from the registered phone %SelectedPrompt%\"\n },\n {\n \"userAttributeName\": \"maxRegistrations\",\n \"userAttributeValue\": \"5\"\n },\n {\n \"userAttributeName\": \"availableforpreferencesui\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"isenabled\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"image\",\n \"userAttributeValue\": \"images/totp.png\"\n },\n {\n \"userAttributeName\": \"adddesc\",\n \"userAttributeValue\": \"Add security key for Oracle Mobile Authenticator\"\n },\n {\n \"userAttributeName\": \"ignoreresync\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"challengeText\",\n \"userAttributeValue\": \"Enter OTP from device {1}\"\n },\n {\n \"userAttributeName\": \"maskregexp\",\n \"userAttributeValue\": \"\\\\d{1,2}\\\\D?\\\\D?(\\\\d{3})\\\\D?\\\\D?(\\\\d{3})\\\\D?(\\\\d{2})\\\\d{2}\"\n },\n {\n \"userAttributeName\": \"addkey\",\n \"userAttributeValue\": \"Key\"\n },\n {\n \"userAttributeName\": \"otp\",\n \"userAttributeValue\": \"false\"\n },\n {\n \"userAttributeName\": \"otpTimeSkew\",\n \"userAttributeValue\": \"5\"\n },\n {\n \"userAttributeName\": \"processor\",\n \"userAttributeValue\": \"oracle.security.uas.core.uio.processor.challenge.SMSUMSOTPChallengeProcessor\"\n },\n {\n \"userAttributeName\": \"maskchar\",\n \"userAttributeValue\": \"*\"\n },\n {\n \"userAttributeName\": \"runtime.ui.incorrectOtpMessage\",\n \"userAttributeValue\": \"Entered OTP is incorrect.\"\n },\n {\n \"userAttributeName\": \"maxAttempts\",\n \"userAttributeValue\": \"0\"\n },\n {\n \"userAttributeName\": \"validationToken\",\n \"userAttributeValue\": \"user1161908053645379_e76d638f0c0af6c9903a86e1d1d42722471e68ed1522b334ed41da8dbcf07e24\"\n },\n {\n \"userAttributeName\": \"promptselectmessage\",\n \"userAttributeValue\": \"Please select one of following channels\"\n },\n {\n \"userAttributeName\": \"availableforpreferencesuireg\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"runtime.ui.clickHereMessage\",\n \"userAttributeValue\": \"Click Here\"\n },\n {\n \"userAttributeName\": \"ispreferred\",\n \"userAttributeValue\": \"false\"\n },\n {\n \"userAttributeName\": \"generatedChallenge\",\n \"userAttributeValue\": \"665159\"\n },\n {\n \"userAttributeName\": \"scheme\",\n \"userAttributeValue\": \"https\"\n },\n {\n \"userAttributeName\": \"displayedInfo\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"HMAC\",\n \"userAttributeValue\": \"HmacSHA1\"\n },\n {\n \"userAttributeName\": \"runtime.ui.cancelMessage\",\n \"userAttributeValue\": \"Return to All Options\"\n },\n {\n \"userAttributeName\": \"OTP_PAIR_SEP\",\n \"userAttributeValue\": \"=\"\n },\n {\n \"userAttributeName\": \"runtime.ui.formSubmitActionPath\",\n \"userAttributeValue\": \"/oaa-totp-factor/login/v1\"\n },\n {\n \"userAttributeName\": \"enabled\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"factorEndpoint\",\n \"userAttributeValue\": \"oaa-totp-factor/runtime\"\n },\n {\n \"userAttributeName\": \"challengeCounterExpiryTime\",\n \"userAttributeValue\": \"180000\"\n },\n {\n \"userAttributeName\": \"default\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"runtime.ui.fields\",\n \"userAttributeValue\": \"field1\"\n },\n {\n \"userAttributeName\": \"addkeyhint\",\n \"userAttributeValue\": \"Enter an alphanumeric key\"\n },\n {\n \"userAttributeName\": \"runtime.ui.factorHeading\",\n \"userAttributeValue\": \"TOTP\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.fieldType\",\n \"userAttributeValue\": \"inputText\"\n },\n {\n \"userAttributeName\": \"promptmessage\",\n \"userAttributeValue\": \"Enter OTP from registered phone\"\n },\n {\n \"userAttributeName\": \"factorBrowserEndpoint\",\n \"userAttributeValue\": \"oaa-totp-factor/pages/login.jsp\"\n },\n {\n \"userAttributeName\": \"addheader\",\n \"userAttributeValue\": \"Add Oracle Mobile Authenticator\"\n },\n {\n \"userAttributeName\": \"loginpage\",\n \"userAttributeValue\": \"rui/\"\n },\n {\n \"userAttributeName\": \"ldapalias.omatotpsecretkey\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"passive\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"factorValidateEndpoint\",\n \"userAttributeValue\": \"validateChallenge/v1\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.fieldId\",\n \"userAttributeValue\": \"otpValue\"\n },\n {\n \"userAttributeName\": \"runtime.ui.signInAsDifferentUserMessage\",\n \"userAttributeValue\": \"Not %USERID%?\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.required\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"autogeneratefields\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"htmlInputType\",\n \"userAttributeValue\": \"text\"\n },\n {\n \"userAttributeName\": \"OTP_SEP\",\n \"userAttributeValue\": \";\"\n }\n ],\n \"requestParams\": [\n {\n \"key\": \"AssertionLevel\",\n \"value\": \"AssuranceLevel1\"\n }\n ],\n \"userId\": \"user1\",\n \"groupId\": \"Default\"\n }\n}" } ] } ], "description": "Challenge the user, initialize the challenge, and then validate the user.\n\nIn this example a request is made to challenge user1. User1 has Email and OMA factors configured. Once the challenge is made, initialize the request to the OMA factor with the correlationId returned.\nOnce intialized, validate the user using the correlationId, nonce and OMATOTP." }, { "name": "Challenge User and Auto Initialize, Validate Challenge", "item": [ { "name": "Challenge User", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaaapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userInfo\": {\n \"userId\": \"user1\",\n \"groups\": [\n \"Default\"\n ]\n },\n \"clientInfo\": {\n \"ctype\": \"API\",\n \"clientSecret\": \"b2484989-5f42-4ad8-b0ab-7bbaa06ee786\",\n \"clientId\": \"c1e08e6a-b555-47e1-84a5-36edd06fbf57\"\n },\n \"context\": {\n \"assuranceLevel\": \"AssuranceLevel1\",\n \"customContext\": {\n \"ipAddr\": \"198.51.100.2\"\n }\n },\n \"timeToLiveInSec\": 300\n}" }, "url": { "raw": "{{oaa-runtime}}/oaa/runtime/authn/v1", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "authn", "v1" ] }, "description": "Challenge the User.\n\nIn this example a request is sent to challenge user10 against the API agent created in \"Create API Agent\" and the associated assurance level \"AssuranceLevel1\".\n\nThe \"clientId\" and \"clientSecret\" of the agent are passed in the request along with the name of the AssuranceLevel to validate the user against.\n\nAs there is a policy and rule defined against AssuranceLevel1 to return the factors in \"FactorGroup1\" if the IP address is in the \"SecureIPRange\" group, then the \"ipAddr\" is passed where the IP is within that secure range.\n\nIn the response, as the user only has one preferred factor (OMAOTP), the user is initialized automatically and the \"correlationId\" and \"nonce\" values are returned. There values are used in the \"Validate Challenge\" request." }, "response": [ { "name": "Example Success Response - Challenge User", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userInfo\": {\n \"userId\": \"user10\",\n \"groups\": [\n \"Default\"\n ]\n },\n \"clientInfo\": {\n \"ctype\": \"API\",\n \"clientSecret\": \"b2484989-5f42-4ad8-b0ab-7bbaa06ee786\",\n \"clientId\": \"c1e08e6a-b555-47e1-84a5-36edd06fbf57\"\n },\n \"context\": {\n \"assuranceLevel\": \"AssuranceLevel1\",\n \"customContext\": {\n \"ipAddr\": \"198.51.100.2\"\n }\n },\n \"timeToLiveInSec\": 300\n}" }, "url": { "raw": "{{oaa-runtime}}/oaa/runtime/authn/v1", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "authn", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 22 Apr 2021 08:26:57 GMT" }, { "key": "transfer-encoding", "value": "chunked" }, { "key": "connection", "value": "keep-alive" } ], "cookie": [], "body": "{\n \"apiResponse\": {\n \"code\": \"OAA-40001\",\n \"status\": \"Pending\",\n \"message\": \"Authentication Required\"\n },\n \"correlationId\": \"73_b5747d9ca5354ff0cda3e57a7e497c8dcb2ceb98e1734e94fcd35d9fd4dc5544\",\n \"challengeselectiontext\": \"Choose a method to login.\",\n \"challengeInfo\": [\n {\n \"displayOrder\": 1,\n \"factorName\": \"Oracle Mobile Authenticator\",\n \"factorKey\": \"ChallengeOMATOTP\",\n \"factorContext\": {\n \"prompts\": [\n {\n \"prompttext\": \"Enter OTP from registered phone\",\n \"prompt\": \"O**************=\",\n \"challengeText\": \"Enter OTP from device Device1\",\n \"requiredInputType\": \"text\",\n \"name\": \"Device1\"\n }\n ],\n \"isSelected\": true,\n \"challengeAttrMap\": [\n {\n \"factorAttributeName\": \"PIN_EXPIRY\",\n \"factorAttributeValue\": \"300000\"\n },\n {\n \"factorAttributeName\": \"retrycount\",\n \"factorAttributeValue\": \"10\"\n },\n {\n \"factorAttributeName\": \"defaultimplementation\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"factorGenerateEndpoint\",\n \"factorAttributeValue\": \"generateChallenge/v1\"\n },\n {\n \"factorAttributeName\": \"otpexpirytimeMs\",\n \"factorAttributeValue\": \"300000\"\n },\n {\n \"factorAttributeName\": \"available\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"pinOnExpiryIncFailureCounter\",\n \"factorAttributeValue\": \"false\"\n },\n {\n \"factorAttributeName\": \"requiredInfo\",\n \"factorAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"factorAttributeName\": \"type\",\n \"factorAttributeValue\": \"totp\"\n },\n {\n \"factorAttributeName\": \"htmlLabel\",\n \"factorAttributeValue\": \"OMA TOTP Code\"\n },\n {\n \"factorAttributeName\": \"isverified\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"otpLength\",\n \"factorAttributeValue\": \"6\"\n },\n {\n \"factorAttributeName\": \"windowSize\",\n \"factorAttributeValue\": \"3\"\n },\n {\n \"factorAttributeName\": \"OTP_TIME_STEP_SIZE\",\n \"factorAttributeValue\": \"30\"\n },\n {\n \"factorAttributeName\": \"encyptKey\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.placeholder\",\n \"factorAttributeValue\": \"Enter OTP\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.verifyButtonMessage\",\n \"factorAttributeValue\": \"Verify\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.label\",\n \"factorAttributeValue\": \"Enter OTP from the registered phone %SelectedPrompt%\"\n },\n {\n \"factorAttributeName\": \"maxRegistrations\",\n \"factorAttributeValue\": \"5\"\n },\n {\n \"factorAttributeName\": \"availableforpreferencesui\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"isenabled\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"image\",\n \"factorAttributeValue\": \"images/totp.png\"\n },\n {\n \"factorAttributeName\": \"adddesc\",\n \"factorAttributeValue\": \"Add security key for Oracle Mobile Authenticator\"\n },\n {\n \"factorAttributeName\": \"ignoreresync\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"challengeText\",\n \"factorAttributeValue\": \"Enter OTP from device {1}\"\n },\n {\n \"factorAttributeName\": \"maskregexp\",\n \"factorAttributeValue\": \"\\\\d{1,2}\\\\D?\\\\D?(\\\\d{3})\\\\D?\\\\D?(\\\\d{3})\\\\D?(\\\\d{2})\\\\d{2}\"\n },\n {\n \"factorAttributeName\": \"addkey\",\n \"factorAttributeValue\": \"Key\"\n },\n {\n \"factorAttributeName\": \"otp\",\n \"factorAttributeValue\": \"false\"\n },\n {\n \"factorAttributeName\": \"otpTimeSkew\",\n \"factorAttributeValue\": \"5\"\n },\n {\n \"factorAttributeName\": \"processor\",\n \"factorAttributeValue\": \"oracle.security.uas.core.uio.processor.challenge.SMSUMSOTPChallengeProcessor\"\n },\n {\n \"factorAttributeName\": \"maskchar\",\n \"factorAttributeValue\": \"*\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.incorrectOtpMessage\",\n \"factorAttributeValue\": \"Entered OTP is incorrect.\"\n },\n {\n \"factorAttributeName\": \"maxAttempts\",\n \"factorAttributeValue\": \"0\"\n },\n {\n \"factorAttributeName\": \"promptselectmessage\",\n \"factorAttributeValue\": \"Please select one of following channels\"\n },\n {\n \"factorAttributeName\": \"availableforpreferencesuireg\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.clickHereMessage\",\n \"factorAttributeValue\": \"Click Here\"\n },\n {\n \"factorAttributeName\": \"ispreferred\",\n \"factorAttributeValue\": \"false\"\n },\n {\n \"factorAttributeName\": \"scheme\",\n \"factorAttributeValue\": \"https\"\n },\n {\n \"factorAttributeName\": \"displayedInfo\",\n \"factorAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"factorAttributeName\": \"HMAC\",\n \"factorAttributeValue\": \"HmacSHA1\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.cancelMessage\",\n \"factorAttributeValue\": \"Return to All Options\"\n },\n {\n \"factorAttributeName\": \"OTP_PAIR_SEP\",\n \"factorAttributeValue\": \"=\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.formSubmitActionPath\",\n \"factorAttributeValue\": \"/oaa-totp-factor/login/v1\"\n },\n {\n \"factorAttributeName\": \"enabled\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"factorEndpoint\",\n \"factorAttributeValue\": \"oaa-totp-factor/runtime\"\n },\n {\n \"factorAttributeName\": \"challengeCounterExpiryTime\",\n \"factorAttributeValue\": \"180000\"\n },\n {\n \"factorAttributeName\": \"default\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.fields\",\n \"factorAttributeValue\": \"field1\"\n },\n {\n \"factorAttributeName\": \"addkeyhint\",\n \"factorAttributeValue\": \"Enter an alphanumeric key\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.factorHeading\",\n \"factorAttributeValue\": \"TOTP\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.fieldType\",\n \"factorAttributeValue\": \"inputText\"\n },\n {\n \"factorAttributeName\": \"promptmessage\",\n \"factorAttributeValue\": \"Enter OTP from registered phone\"\n },\n {\n \"factorAttributeName\": \"factorBrowserEndpoint\",\n \"factorAttributeValue\": \"oaa-totp-factor/pages/login.jsp\"\n },\n {\n \"factorAttributeName\": \"addheader\",\n \"factorAttributeValue\": \"Add Oracle Mobile Authenticator\"\n },\n {\n \"factorAttributeName\": \"loginpage\",\n \"factorAttributeValue\": \"rui/\"\n },\n {\n \"factorAttributeName\": \"ldapalias.omatotpsecretkey\",\n \"factorAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"factorAttributeName\": \"passive\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"factorValidateEndpoint\",\n \"factorAttributeValue\": \"validateChallenge/v1\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.fieldId\",\n \"factorAttributeValue\": \"otpValue\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.signInAsDifferentUserMessage\",\n \"factorAttributeValue\": \"Not %USERID%?\"\n },\n {\n \"factorAttributeName\": \"runtime.ui.field1.required\",\n \"factorAttributeValue\": \"true\"\n },\n {\n \"factorAttributeName\": \"autogeneratefields\",\n \"factorAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"factorAttributeName\": \"htmlInputType\",\n \"factorAttributeValue\": \"text\"\n },\n {\n \"factorAttributeName\": \"OTP_SEP\",\n \"factorAttributeValue\": \";\"\n }\n ]\n }\n }\n ],\n \"nonce\": \"186c288d-500e-4baf-be23-600e2c2d029f\",\n \"challengecontext\": {\n \"factorKey\": \"ChallengeOMATOTP\",\n \"timeToLiveInSec\": 300,\n \"factorAttributes\": [\n {\n \"userAttributeName\": \"PIN_EXPIRY\",\n \"userAttributeValue\": \"300000\"\n },\n {\n \"userAttributeName\": \"retrycount\",\n \"userAttributeValue\": \"10\"\n },\n {\n \"userAttributeName\": \"defaultimplementation\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"factorGenerateEndpoint\",\n \"userAttributeValue\": \"generateChallenge/v1\"\n },\n {\n \"userAttributeName\": \"otpexpirytimeMs\",\n \"userAttributeValue\": \"300000\"\n },\n {\n \"userAttributeName\": \"available\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"pinOnExpiryIncFailureCounter\",\n \"userAttributeValue\": \"false\"\n },\n {\n \"userAttributeName\": \"requiredInfo\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"type\",\n \"userAttributeValue\": \"totp\"\n },\n {\n \"userAttributeName\": \"htmlLabel\",\n \"userAttributeValue\": \"OMA TOTP Code\"\n },\n {\n \"userAttributeName\": \"isverified\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"otpLength\",\n \"userAttributeValue\": \"6\"\n },\n {\n \"userAttributeName\": \"windowSize\",\n \"userAttributeValue\": \"3\"\n },\n {\n \"userAttributeName\": \"OTP_TIME_STEP_SIZE\",\n \"userAttributeValue\": \"30\"\n },\n {\n \"userAttributeName\": \"encyptKey\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.placeholder\",\n \"userAttributeValue\": \"Enter OTP\"\n },\n {\n \"userAttributeName\": \"runtime.ui.verifyButtonMessage\",\n \"userAttributeValue\": \"Verify\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.label\",\n \"userAttributeValue\": \"Enter OTP from the registered phone %SelectedPrompt%\"\n },\n {\n \"userAttributeName\": \"maxRegistrations\",\n \"userAttributeValue\": \"5\"\n },\n {\n \"userAttributeName\": \"availableforpreferencesui\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"isenabled\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"image\",\n \"userAttributeValue\": \"images/totp.png\"\n },\n {\n \"userAttributeName\": \"adddesc\",\n \"userAttributeValue\": \"Add security key for Oracle Mobile Authenticator\"\n },\n {\n \"userAttributeName\": \"ignoreresync\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"challengeText\",\n \"userAttributeValue\": \"Enter OTP from device {1}\"\n },\n {\n \"userAttributeName\": \"maskregexp\",\n \"userAttributeValue\": \"\\\\d{1,2}\\\\D?\\\\D?(\\\\d{3})\\\\D?\\\\D?(\\\\d{3})\\\\D?(\\\\d{2})\\\\d{2}\"\n },\n {\n \"userAttributeName\": \"addkey\",\n \"userAttributeValue\": \"Key\"\n },\n {\n \"userAttributeName\": \"otp\",\n \"userAttributeValue\": \"false\"\n },\n {\n \"userAttributeName\": \"otpTimeSkew\",\n \"userAttributeValue\": \"5\"\n },\n {\n \"userAttributeName\": \"processor\",\n \"userAttributeValue\": \"oracle.security.uas.core.uio.processor.challenge.SMSUMSOTPChallengeProcessor\"\n },\n {\n \"userAttributeName\": \"maskchar\",\n \"userAttributeValue\": \"*\"\n },\n {\n \"userAttributeName\": \"runtime.ui.incorrectOtpMessage\",\n \"userAttributeValue\": \"Entered OTP is incorrect.\"\n },\n {\n \"userAttributeName\": \"maxAttempts\",\n \"userAttributeValue\": \"0\"\n },\n {\n \"userAttributeName\": \"validationToken\",\n \"userAttributeValue\": \"user10161908001721973_b5747d9ca5354ff0cda3e57a7e497c8dcb2ceb98e1734e94fcd35d9fd4dc5544\"\n },\n {\n \"userAttributeName\": \"promptselectmessage\",\n \"userAttributeValue\": \"Please select one of following channels\"\n },\n {\n \"userAttributeName\": \"availableforpreferencesuireg\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"runtime.ui.clickHereMessage\",\n \"userAttributeValue\": \"Click Here\"\n },\n {\n \"userAttributeName\": \"ispreferred\",\n \"userAttributeValue\": \"false\"\n },\n {\n \"userAttributeName\": \"generatedChallenge\",\n \"userAttributeValue\": \"658317\"\n },\n {\n \"userAttributeName\": \"scheme\",\n \"userAttributeValue\": \"https\"\n },\n {\n \"userAttributeName\": \"displayedInfo\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"HMAC\",\n \"userAttributeValue\": \"HmacSHA1\"\n },\n {\n \"userAttributeName\": \"runtime.ui.cancelMessage\",\n \"userAttributeValue\": \"Return to All Options\"\n },\n {\n \"userAttributeName\": \"OTP_PAIR_SEP\",\n \"userAttributeValue\": \"=\"\n },\n {\n \"userAttributeName\": \"runtime.ui.formSubmitActionPath\",\n \"userAttributeValue\": \"/oaa-totp-factor/login/v1\"\n },\n {\n \"userAttributeName\": \"enabled\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"factorEndpoint\",\n \"userAttributeValue\": \"oaa-totp-factor/runtime\"\n },\n {\n \"userAttributeName\": \"challengeCounterExpiryTime\",\n \"userAttributeValue\": \"180000\"\n },\n {\n \"userAttributeName\": \"default\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"runtime.ui.fields\",\n \"userAttributeValue\": \"field1\"\n },\n {\n \"userAttributeName\": \"addkeyhint\",\n \"userAttributeValue\": \"Enter an alphanumeric key\"\n },\n {\n \"userAttributeName\": \"runtime.ui.factorHeading\",\n \"userAttributeValue\": \"TOTP\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.fieldType\",\n \"userAttributeValue\": \"inputText\"\n },\n {\n \"userAttributeName\": \"promptmessage\",\n \"userAttributeValue\": \"Enter OTP from registered phone\"\n },\n {\n \"userAttributeName\": \"factorBrowserEndpoint\",\n \"userAttributeValue\": \"oaa-totp-factor/pages/login.jsp\"\n },\n {\n \"userAttributeName\": \"addheader\",\n \"userAttributeValue\": \"Add Oracle Mobile Authenticator\"\n },\n {\n \"userAttributeName\": \"loginpage\",\n \"userAttributeValue\": \"rui/\"\n },\n {\n \"userAttributeName\": \"ldapalias.omatotpsecretkey\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"passive\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"factorValidateEndpoint\",\n \"userAttributeValue\": \"validateChallenge/v1\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.fieldId\",\n \"userAttributeValue\": \"otpValue\"\n },\n {\n \"userAttributeName\": \"runtime.ui.signInAsDifferentUserMessage\",\n \"userAttributeValue\": \"Not %USERID%?\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.required\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"autogeneratefields\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"htmlInputType\",\n \"userAttributeValue\": \"text\"\n },\n {\n \"userAttributeName\": \"OTP_SEP\",\n \"userAttributeValue\": \";\"\n }\n ],\n \"requestParams\": [\n {\n \"key\": \"AssertionLevel\",\n \"value\": \"AssuranceLevel1\"\n }\n ],\n \"userId\": \"user10\",\n \"groupId\": \"Default\"\n }\n}" } ] }, { "name": "Validate Challenge", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaaapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"correlationId\": \"73_b5747d9ca5354ff0cda3e57a7e497c8dcb2ceb98e1734e94fcd35d9fd4dc5544\",\n \"challengeop\": \"Validate\",\n \"challengeAnswer\" : \"951270\",\n \"nonce\": \"186c288d-500e-4baf-be23-600e2c2d029f\"\n}" }, "url": { "raw": "{{oaa-runtime}}/oaa/runtime/authn/v1", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "authn", "v1" ] }, "description": "Validate the Challenge.\n\nIn this example the challenge for user10 is validated. The \"correlationId\" and \"nonce\" returned in the previous \"Challenge User\" request are passed as parameters, along with a valid OTP code from OMA.\n\nIf the OMATOTP code is validated successfully the response shows an ORA-40004 Authentication Success message." }, "response": [ { "name": "Example Success Response - Validate Challenge", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"correlationId\": \"73_b5747d9ca5354ff0cda3e57a7e497c8dcb2ceb98e1734e94fcd35d9fd4dc5544\",\n \"challengeop\": \"Validate\",\n \"challengeAnswer\" : \"951270\",\n \"nonce\": \"186c288d-500e-4baf-be23-600e2c2d029f\"\n}" }, "url": { "raw": "{{oaa-runtime}}/oaa/runtime/authn/v1", "host": [ "{{oaa-runtime}}" ], "path": [ "oaa", "runtime", "authn", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Thu, 22 Apr 2021 08:31:38 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "5613" } ], "cookie": [], "body": "{\n \"apiResponse\": {\n \"code\": \"OAA-40004\",\n \"status\": \"Authenticated\",\n \"message\": \"Authentication Success\"\n },\n \"correlationId\": \"73_b5747d9ca5354ff0cda3e57a7e497c8dcb2ceb98e1734e94fcd35d9fd4dc5544\",\n \"nonce\": \"186c288d-500e-4baf-be23-600e2c2d029f\",\n \"challengecontext\": {\n \"factorKey\": \"ChallengeOMATOTP\",\n \"timeToLiveInSec\": 300,\n \"factorAttributes\": [\n {\n \"userAttributeName\": \"PIN_EXPIRY\",\n \"userAttributeValue\": \"300000\"\n },\n {\n \"userAttributeName\": \"retrycount\",\n \"userAttributeValue\": \"10\"\n },\n {\n \"userAttributeName\": \"defaultimplementation\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"factorGenerateEndpoint\",\n \"userAttributeValue\": \"generateChallenge/v1\"\n },\n {\n \"userAttributeName\": \"otpexpirytimeMs\",\n \"userAttributeValue\": \"300000\"\n },\n {\n \"userAttributeName\": \"available\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"pinOnExpiryIncFailureCounter\",\n \"userAttributeValue\": \"false\"\n },\n {\n \"userAttributeName\": \"requiredInfo\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"type\",\n \"userAttributeValue\": \"totp\"\n },\n {\n \"userAttributeName\": \"htmlLabel\",\n \"userAttributeValue\": \"OMA TOTP Code\"\n },\n {\n \"userAttributeName\": \"isverified\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"otpLength\",\n \"userAttributeValue\": \"6\"\n },\n {\n \"userAttributeName\": \"windowSize\",\n \"userAttributeValue\": \"3\"\n },\n {\n \"userAttributeName\": \"OTP_TIME_STEP_SIZE\",\n \"userAttributeValue\": \"30\"\n },\n {\n \"userAttributeName\": \"encyptKey\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.placeholder\",\n \"userAttributeValue\": \"Enter OTP\"\n },\n {\n \"userAttributeName\": \"runtime.ui.verifyButtonMessage\",\n \"userAttributeValue\": \"Verify\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.label\",\n \"userAttributeValue\": \"Enter OTP from the registered phone %SelectedPrompt%\"\n },\n {\n \"userAttributeName\": \"maxRegistrations\",\n \"userAttributeValue\": \"5\"\n },\n {\n \"userAttributeName\": \"availableforpreferencesui\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"isenabled\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"image\",\n \"userAttributeValue\": \"images/totp.png\"\n },\n {\n \"userAttributeName\": \"adddesc\",\n \"userAttributeValue\": \"Add security key for Oracle Mobile Authenticator\"\n },\n {\n \"userAttributeName\": \"ignoreresync\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"challengeText\",\n \"userAttributeValue\": \"Enter OTP from device {1}\"\n },\n {\n \"userAttributeName\": \"maskregexp\",\n \"userAttributeValue\": \"\\\\d{1,2}\\\\D?\\\\D?(\\\\d{3})\\\\D?\\\\D?(\\\\d{3})\\\\D?(\\\\d{2})\\\\d{2}\"\n },\n {\n \"userAttributeName\": \"addkey\",\n \"userAttributeValue\": \"Key\"\n },\n {\n \"userAttributeName\": \"otp\",\n \"userAttributeValue\": \"false\"\n },\n {\n \"userAttributeName\": \"otpTimeSkew\",\n \"userAttributeValue\": \"5\"\n },\n {\n \"userAttributeName\": \"processor\",\n \"userAttributeValue\": \"oracle.security.uas.core.uio.processor.challenge.SMSUMSOTPChallengeProcessor\"\n },\n {\n \"userAttributeName\": \"maskchar\",\n \"userAttributeValue\": \"*\"\n },\n {\n \"userAttributeName\": \"runtime.ui.incorrectOtpMessage\",\n \"userAttributeValue\": \"Entered OTP is incorrect.\"\n },\n {\n \"userAttributeName\": \"maxAttempts\",\n \"userAttributeValue\": \"0\"\n },\n {\n \"userAttributeName\": \"validationToken\",\n \"userAttributeValue\": \"user10161908001721973_b5747d9ca5354ff0cda3e57a7e497c8dcb2ceb98e1734e94fcd35d9fd4dc5544\"\n },\n {\n \"userAttributeName\": \"promptselectmessage\",\n \"userAttributeValue\": \"Please select one of following channels\"\n },\n {\n \"userAttributeName\": \"availableforpreferencesuireg\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"runtime.ui.clickHereMessage\",\n \"userAttributeValue\": \"Click Here\"\n },\n {\n \"userAttributeName\": \"ispreferred\",\n \"userAttributeValue\": \"false\"\n },\n {\n \"userAttributeName\": \"generatedChallenge\",\n \"userAttributeValue\": \"658317\"\n },\n {\n \"userAttributeName\": \"scheme\",\n \"userAttributeValue\": \"https\"\n },\n {\n \"userAttributeName\": \"displayedInfo\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"HMAC\",\n \"userAttributeValue\": \"HmacSHA1\"\n },\n {\n \"userAttributeName\": \"runtime.ui.cancelMessage\",\n \"userAttributeValue\": \"Return to All Options\"\n },\n {\n \"userAttributeName\": \"OTP_PAIR_SEP\",\n \"userAttributeValue\": \"=\"\n },\n {\n \"userAttributeName\": \"runtime.ui.formSubmitActionPath\",\n \"userAttributeValue\": \"/oaa-totp-factor/login/v1\"\n },\n {\n \"userAttributeName\": \"enabled\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"factorEndpoint\",\n \"userAttributeValue\": \"oaa-totp-factor/runtime\"\n },\n {\n \"userAttributeName\": \"challengeCounterExpiryTime\",\n \"userAttributeValue\": \"180000\"\n },\n {\n \"userAttributeName\": \"default\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"runtime.ui.fields\",\n \"userAttributeValue\": \"field1\"\n },\n {\n \"userAttributeName\": \"addkeyhint\",\n \"userAttributeValue\": \"Enter an alphanumeric key\"\n },\n {\n \"userAttributeName\": \"runtime.ui.factorHeading\",\n \"userAttributeValue\": \"TOTP\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.fieldType\",\n \"userAttributeValue\": \"inputText\"\n },\n {\n \"userAttributeName\": \"promptmessage\",\n \"userAttributeValue\": \"Enter OTP from registered phone\"\n },\n {\n \"userAttributeName\": \"factorBrowserEndpoint\",\n \"userAttributeValue\": \"oaa-totp-factor/pages/login.jsp\"\n },\n {\n \"userAttributeName\": \"addheader\",\n \"userAttributeValue\": \"Add Oracle Mobile Authenticator\"\n },\n {\n \"userAttributeName\": \"loginpage\",\n \"userAttributeValue\": \"rui/\"\n },\n {\n \"userAttributeName\": \"ldapalias.omatotpsecretkey\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"passive\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"factorValidateEndpoint\",\n \"userAttributeValue\": \"validateChallenge/v1\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.fieldId\",\n \"userAttributeValue\": \"otpValue\"\n },\n {\n \"userAttributeName\": \"runtime.ui.signInAsDifferentUserMessage\",\n \"userAttributeValue\": \"Not %USERID%?\"\n },\n {\n \"userAttributeName\": \"runtime.ui.field1.required\",\n \"userAttributeValue\": \"true\"\n },\n {\n \"userAttributeName\": \"autogeneratefields\",\n \"userAttributeValue\": \"omatotpsecretkey\"\n },\n {\n \"userAttributeName\": \"htmlInputType\",\n \"userAttributeValue\": \"text\"\n },\n {\n \"userAttributeName\": \"OTP_SEP\",\n \"userAttributeValue\": \";\"\n }\n ],\n \"requestParams\": [\n {\n \"key\": \"AssertionLevel\",\n \"value\": \"AssuranceLevel1\"\n }\n ],\n \"userId\": \"user10\",\n \"groupId\": \"Default\"\n }\n}" } ] } ], "description": "In this example a request is made to challenge user10. User10 has only OMA set as the preferred factor. Once the challenge is made, as the user only has one factor the user is auto initialized, and only a validate is then required. \n\nValidation occurs for the user using the correlationId, nonce and OMATOTP." } ] } ], "description": "This API describes OAA runtime API which in turn will interact with OAA APIs to simplify the interaction with the service provider. Service Provider(SP) can interact with OAA Runtime api to limit the number of interaction required between SP and UAS.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "REST API for Oracle UMS Configuration", "item": [ { "name": "Configure Oracle UMS Server in OAA", "request": { "auth": { "type": "basic", "basic": [ { "key": "password", "value": "{{oaapolicyapikey}}", "type": "string" }, { "key": "username", "value": "{{RELEASENAME}}-oaa-policy", "type": "string" }, { "key": "saveHelperData", "value": true, "type": "boolean" }, { "key": "showPassword", "value": false, "type": "boolean" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\r\n {\r\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.umsClientURL\",\r\n \"value\": \"http://ums.example.com:8001/ucs/messaging/webservice\"\r\n \r\n},\r\n{\r\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.umsClientName\",\r\n \"value\": \"umsuser\"\r\n \r\n},\r\n{\r\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress\",\r\n \"value\": \"demo@example.com\"\r\n},\r\n{\r\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.umsClientPass\",\r\n \"value\": \"\"\r\n \r\n}\r\n]" }, "url": { "raw": "{{oaa-policy}}/policy/config/property/v1", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ] }, "description": "Configure Oracle UMS Server in OAA.\n\nSet the properties to configure OAA to use the Oracle UMS Server for email." }, "response": [ { "name": "Example Success Response - Configure Oracle UMS Server in OAA", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "[\r\n {\r\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.umsClientURL\",\r\n \"value\": \"http://ums.example.com:8001/ucs/messaging/webservice\"\r\n \r\n},\r\n{\r\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.umsClientName\",\r\n \"value\": \"umsuser\"\r\n \r\n},\r\n{\r\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress\",\r\n \"value\": \"demo@oracle.com\",\r\n \"source\": \"database\"\r\n},\r\n{\r\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.umsClientPass\",\r\n \"value\": \"\"\r\n \r\n}\r\n]" }, "url": { "raw": "{{oaa-policy}}/policy/config/property/v1", "host": [ "{{oaa-policy}}" ], "path": [ "policy", "config", "property", "v1" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Date", "value": "Fri, 5 Mar 2021 10:54:58 GMT" }, { "key": "connection", "value": "keep-alive" }, { "key": "content-length", "value": "398" } ], "cookie": [], "body": "[\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.umsClientURL\",\n \"value\": \"http://ums.example.com:8001/ucs/messaging/webservice\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.umsClientName\",\n \"value\": \"umsuser\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress\",\n \"value\": \"demo@oracle.com\",\n \"source\": \"database\"\n },\n {\n \"name\": \"bharosa.uio.default.challenge.type.enum.ChallengeEmail.umsClientPass\",\n \"value\": \"\",\n \"source\": \"database\"\n }\n]" } ] } ] } ] }