{ "info": { "name": "WebFrolic API", "_postman_id": "b7c1f0a2-5d3e-4a21-9f68-webfrolic0001", "description": "# WebFrolic API\n\n78 endpoints across 10 groups, generated from the published OpenAPI 3.1.0 document (`/v3/api-docs`, version v0).\n\n## Before you start\n\n1. Set **baseUrl** if you are not using `https://b.cell.webfrolic.com`.\n2. Put your credential in the **token** variable. The collection sends it as a bearer token on every request.\n3. Fill the id variables (`tenantId`, `userId`, `groupId` \u2026) as you need them, or override them per request.\n\n## Two things the spec does not state\n\n- **The authentication scheme.** The document records only that unauthenticated calls return `403 Not Authorized`. Bearer is this collection's assumption; change the Authorization tab if your deployment expects an API-key header or a session cookie.\n- **The error body.** `ApiError` and `ScimError` are named but their shape is not published, so no error examples are included.\n\n## Notes\n\n- SCIM requests send `Content-Type: application/scim+json`; the rest send `application/json`.\n- Request bodies are generated from the published models. Fields you do not need can be removed.\n- Optional query parameters are included but disabled, except where the spec gives a default.\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "item": [ { "name": "Tenant SCIM Operations", "description": "Manage tenant users and groups via SCIM operations", "item": [ { "name": "Get a list of SCIM groups for a tenant", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/:tenantId/scim2/Groups?startIndex=1&count=30", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", ":tenantId", "scim2", "Groups" ], "query": [ { "key": "startIndex", "value": "1", "description": "Default: `1` (optional)", "disabled": false }, { "key": "count", "value": "30", "description": "Default: `30` (optional)", "disabled": false } ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "description": "Get a list of SCIM groups for a tenant\n\n**Operation ID:** `queryScimGroups`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully retrieved a list by groups by page number if provided |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Create a SCIM group for tenant", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/scim+json" } ], "url": { "raw": "{{baseUrl}}/api/idp/:tenantId/scim2/Groups", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", ":tenantId", "scim2", "Groups" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n ],\n \"displayName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a SCIM group for tenant\n\n**Operation ID:** `createScimGroup`\n\n**Request body:** `ScimGroupRequest` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully craete a group |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `409` | Record Already Exists |" }, "response": [] }, { "name": "Delete a SCIM group for tenant by groupId", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/:tenantId/scim2/Groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", ":tenantId", "scim2", "Groups", ":id" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" }, { "key": "id", "value": "{{id}}", "description": "SCIM resource identifier" } ] }, "description": "Delete a SCIM group for tenant by groupId\n\n**Operation ID:** `deleteScimGroup`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | No Content |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Get a tenant SCIM group by groupId", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/:tenantId/scim2/Groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", ":tenantId", "scim2", "Groups", ":id" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" }, { "key": "id", "value": "{{id}}", "description": "SCIM resource identifier" } ] }, "description": "Get a tenant SCIM group by groupId\n\n**Operation ID:** `getScimGroup`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully retrieved a group by groupId |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Manage the members for a SCIM group", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/scim+json" } ], "url": { "raw": "{{baseUrl}}/api/idp/:tenantId/scim2/Groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", ":tenantId", "scim2", "Groups", ":id" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" }, { "key": "id", "value": "{{id}}", "description": "SCIM resource identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n ],\n \"Operations\": [\n {\n \"op\": \"\",\n \"path\": \"\",\n \"value\": []\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Manage the members for a SCIM group\n\n**Operation ID:** `patchScimGroup`\n\n**Request body:** `ScimGroupPatch` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully updated group memberships |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |\n| `409` | Record Already Exists |" }, "response": [] }, { "name": "Not Supported. Create a tenant group if it does not exists alreadt.", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/scim+json" } ], "url": { "raw": "{{baseUrl}}/api/idp/:tenantId/scim2/Groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", ":tenantId", "scim2", "Groups", ":id" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" }, { "key": "id", "value": "{{id}}", "description": "SCIM resource identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n ],\n \"displayName\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"resourceType\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"members\": [\n {\n \"display\": \"\",\n \"value\": \"\",\n \"$ref\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Not Supported. Create a tenant group if it does not exists alreadt.\n\n**Operation ID:** `upsertScimGroup`\n\n**Request body:** `ScimGroup` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | OK |" }, "response": [] }, { "name": "Query for tenant members. Filter supported for username and work email", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/:tenantId/scim2/Users?filter=&startIndex=1&count=30", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", ":tenantId", "scim2", "Users" ], "query": [ { "key": "filter", "value": "", "description": "(optional)", "disabled": true }, { "key": "startIndex", "value": "1", "description": "Default: `1` (optional)", "disabled": false }, { "key": "count", "value": "30", "description": "Default: `30` (optional)", "disabled": false } ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "description": "Query for tenant members. Filter supported for username and work email\n\n**Operation ID:** `queryUser`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully retrieved a list by groups by page number if provided |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Creates a tenant member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/scim+json" } ], "url": { "raw": "{{baseUrl}}/api/idp/:tenantId/scim2/Users", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", ":tenantId", "scim2", "Users" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"userName\": \"\",\n \"active\": true,\n \"name\": {\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"emails\": [\n {\n \"primary\": true,\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"id\": \"\",\n \"meta\": {\n \"resourceType\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a tenant member\n\n**Operation ID:** `createUser`\n\n**Request body:** `ScimUser` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully created a User |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | User not found |\n| `409` | User Already Exists |" }, "response": [] }, { "name": "Deletes a tenant member", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/:tenantId/scim2/Users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", ":tenantId", "scim2", "Users", ":id" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" }, { "key": "id", "value": "{{id}}", "description": "SCIM resource identifier" } ] }, "description": "Deletes a tenant member\n\n**Operation ID:** `deleteUser`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | Successfully deleted a User |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | User not found |" }, "response": [] }, { "name": "Get a tenant member", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/:tenantId/scim2/Users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", ":tenantId", "scim2", "Users", ":id" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" }, { "key": "id", "value": "{{id}}", "description": "SCIM resource identifier" } ] }, "description": "Get a tenant member\n\n**Operation ID:** `get`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully retrieved a User by userId |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | User not found |" }, "response": [] }, { "name": "Update a tenant member", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/scim+json" } ], "url": { "raw": "{{baseUrl}}/api/idp/:tenantId/scim2/Users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", ":tenantId", "scim2", "Users", ":id" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" }, { "key": "id", "value": "{{id}}", "description": "SCIM resource identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"userName\": \"\",\n \"active\": true,\n \"name\": {\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"emails\": [\n {\n \"primary\": true,\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"id\": \"\",\n \"meta\": {\n \"resourceType\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Update a tenant member\n\n**Operation ID:** `updateUser`\n\n**Request body:** `ScimUser` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Updates a SCIM User |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | User not found |" }, "response": [] } ] }, { "name": "Vault Operations", "description": "Manage Vault secrets and OAuth Credentials", "item": [ { "name": "Deletes a secret", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/vault?secretName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "vault" ], "query": [ { "key": "secretName", "value": "", "description": "Required parameter (required)", "disabled": false } ] }, "description": "Deletes a secret\n\n**Operation ID:** `deleteSecret`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | Secret Deleted Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Not Found |" }, "response": [] }, { "name": "Create a plain secret", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/vault", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "vault" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"nameSpace\": \"\",\n \"secretValue\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a plain secret\n\n**Operation ID:** `createSecret`\n\n**Request body:** `VaultSecret` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `201` | Secret Created Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Updates a plain secret", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/vault", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "vault" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"nameSpace\": \"\",\n \"secretValue\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a plain secret\n\n**Operation ID:** `updateSecret`\n\n**Request body:** `VaultSecret` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Secret Updated Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Not Found |" }, "response": [] }, { "name": "Create a secret to store OAuth2 Credentials", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/vault/oauth", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "vault", "oauth" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"nameSpace\": \"\",\n \"tokenEndpoint\": \"\",\n \"scope\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a secret to store OAuth2 Credentials\n\n**Operation ID:** `createOAuthSecret`\n\n**Request body:** `VaultOAuthSecret` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `201` | Secret Created Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Updates a secret for OAuth2 Credentials", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/vault/oauth", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "vault", "oauth" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"nameSpace\": \"\",\n \"tokenEndpoint\": \"\",\n \"scope\": \"\",\n \"clientId\": \"\",\n \"clientSecret\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a secret for OAuth2 Credentials\n\n**Operation ID:** `updateOAuthSecret`\n\n**Request body:** `VaultOAuthSecret` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Secret Updated Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Not Found |" }, "response": [] }, { "name": "Query secret by name", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/vault/query?secretName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "vault", "query" ], "query": [ { "key": "secretName", "value": "", "description": "Required parameter (required)", "disabled": false } ] }, "description": "Query secret by name\n\n**Operation ID:** `getSecretValue`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns the secret value if its plain secret, or returns the Access Token if its an OAuth Credential |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] } ] }, { "name": "Variable Operations", "description": "Manage Configuration Variables", "item": [ { "name": "Deletes a variable", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/variable?variableName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "variable" ], "query": [ { "key": "variableName", "value": "", "description": "Required parameter (required)", "disabled": false } ] }, "description": "Deletes a variable\n\n**Operation ID:** `deleteVariable`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | variable Deleted Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Not Found |" }, "response": [] }, { "name": "Create a variable", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/variable", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "variable" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"nameSpace\": \"\",\n \"value\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a variable\n\n**Operation ID:** `createVariable`\n\n**Request body:** `Variable` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `201` | Variable Created Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Updates a variable", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/variable", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "variable" ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"nameSpace\": \"\",\n \"value\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a variable\n\n**Operation ID:** `updateVariable`\n\n**Request body:** `Variable` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Variable Updated Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Not Found |" }, "response": [] }, { "name": "Query variable by name", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/variable/query?variableName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "variable", "query" ], "query": [ { "key": "variableName", "value": "", "description": "Required parameter (required)", "disabled": false } ] }, "description": "Query variable by name\n\n**Operation ID:** `getVariableValue`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns the variable value |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] } ] }, { "name": "User API Operations", "description": "Manage User", "item": [ { "name": "Retrieve users in paginated manner. Filters for email and user type supported", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/user?email=&category=customer&pageNumber=0&pageSize=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "user" ], "query": [ { "key": "email", "value": "", "description": "Optional parameter, allows to filter user by email address (optional)", "disabled": true }, { "key": "category", "value": "customer", "description": "Optional parameter, defaults to Customer. Supported Values CUSTOMER, EMPLOYEE Default: `customer` (optional)", "disabled": false }, { "key": "pageNumber", "value": "0", "description": "Default: `0` (optional)", "disabled": false }, { "key": "pageSize", "value": "25", "description": "Default: `25` (optional)", "disabled": false } ] }, "description": "Retrieve users in paginated manner. Filters for email and user type supported\n\n**Operation ID:** `getUser_1`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully retrieved a list by users by page number if provided |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Create user record", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/user?userType=REGULAR&category=customer", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "user" ], "query": [ { "key": "userType", "value": "REGULAR", "description": "Optional parameter, defaults to Regular. Supported Values SERIVCE, TEST, REGULAR Default: `REGULAR` (optional)", "disabled": false }, { "key": "category", "value": "customer", "description": "Optional parameter, defaults to Customer. Supported Values CUSTOMER, EMPLOYEE Default: `customer` (optional)", "disabled": false } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"status\": \"\",\n \"attributes\": [\n null\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Create user record\n\n**Operation ID:** `createUser_1`\n\n**Request body:** `User` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `201` | User Created Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Delete a User Session", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/user/:customerId/session/:sessionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "user", ":customerId", "session", ":sessionId" ], "variable": [ { "key": "customerId", "value": "{{customerId}}", "description": "Customer identifier used by the session endpoints" }, { "key": "sessionId", "value": "{{sessionId}}", "description": "Session identifier" } ] }, "description": "Delete a User Session\n\n**Operation ID:** `getSchema`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | Session Deleted |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | User session not found |" }, "response": [] }, { "name": "Retrieve a User Session", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/user/:customerId/session/:sessionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "user", ":customerId", "session", ":sessionId" ], "variable": [ { "key": "customerId", "value": "{{customerId}}", "description": "Customer identifier used by the session endpoints" }, { "key": "sessionId", "value": "{{sessionId}}", "description": "Session identifier" } ] }, "description": "Retrieve a User Session\n\n**Operation ID:** `getSession`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns a User session by sessionId |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | User session not found |" }, "response": [] }, { "name": "Update User Session", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/user/:customerId/session/:sessionId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "user", ":customerId", "session", ":sessionId" ], "variable": [ { "key": "customerId", "value": "{{customerId}}", "description": "Customer identifier used by the session endpoints" }, { "key": "sessionId", "value": "{{sessionId}}", "description": "Session identifier" } ] }, "description": "Update User Session\n\n**Operation ID:** `updateSession`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | Session Updated |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | User session not found |" }, "response": [] }, { "name": "Deletes user by userId", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/user/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "user", ":userId" ], "variable": [ { "key": "userId", "value": "{{userId}}", "description": "User identifier" } ] }, "description": "Deletes user by userId\n\n**Operation ID:** `deleteUser_1`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | User Deleted Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Retrieves a user for a given userId", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/user/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "user", ":userId" ], "variable": [ { "key": "userId", "value": "{{userId}}", "description": "User identifier" } ] }, "description": "Retrieves a user for a given userId\n\n**Operation ID:** `getUser`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | User retrieved Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Updates a user record", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/user/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "user", ":userId" ], "variable": [ { "key": "userId", "value": "{{userId}}", "description": "User identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"status\": \"\",\n \"attributes\": [\n null\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a user record\n\n**Operation ID:** `updateUser_1`\n\n**Request body:** `User` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | User Updated Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] } ] }, { "name": "Tenant Operations", "description": "Manage Tenants, tenant Groups and Memberships", "item": [ { "name": "Retrieve tenant list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant?pageNumber=0&pageSize=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant" ], "query": [ { "key": "pageNumber", "value": "0", "description": "Default: `0` (optional)", "disabled": false }, { "key": "pageSize", "value": "25", "description": "Default: `25` (optional)", "disabled": false } ] }, "description": "Retrieve tenant list\n\n**Operation ID:** `getTenant_1`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully retrives the tenant list |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Create a Tenant", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant?member=False&defaultRole=", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant" ], "query": [ { "key": "member", "value": "False", "description": "Optional boolean parameter, add the callee as a tenant member and owner if set to true Default: `False` (optional)", "disabled": false }, { "key": "defaultRole", "value": "", "description": "Optional parameter, assigns the given role to the callee if the tenant role exists (optional)", "disabled": true } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"description\": \"\",\n \"homePage\": \"\",\n \"attributes\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a Tenant\n\n**Operation ID:** `createTenant`\n\n**Request body:** `Tenant` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `201` | Tenant Created Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Delete a Tenant", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "description": "Delete a Tenant\n\n**Operation ID:** `deleteTenant`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | Tenant Deleted Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Retrieves a Tenant", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "description": "Retrieves a Tenant\n\n**Operation ID:** `getTenant`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns Tenant if exists |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Not Found |" }, "response": [] }, { "name": "Update a Tenant", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"description\": \"\",\n \"homePage\": \"\",\n \"attributes\": {}\n}", "options": { "raw": { "language": "json" } } }, "description": "Update a Tenant\n\n**Operation ID:** `updateTenant`\n\n**Request body:** `Tenant` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Tenant Updated Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Retrieve tenant group list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId/group?pageNumber=0&pageSize=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId", "group" ], "query": [ { "key": "pageNumber", "value": "0", "description": "Default: `0` (optional)", "disabled": false }, { "key": "pageSize", "value": "25", "description": "Default: `25` (optional)", "disabled": false } ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "description": "Retrieve tenant group list\n\n**Operation ID:** `getGroup_2`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully retrives the group list |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Create a tenant group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId/group", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId", "group" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"memberCount\": 0,\n \"createdOn\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"description\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a tenant group\n\n**Operation ID:** `createGroup`\n\n**Request body:** `TenantGroup` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `201` | Successfully created the group |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Delete a tenant group by groupId", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId/group/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId", "group", ":groupId" ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "Group identifier" }, { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "description": "Delete a tenant group by groupId\n\n**Operation ID:** `deleteGroup`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | Successfully deleted the group |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Get a Tenant group by groupId", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId/group/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId", "group", ":groupId" ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "Group identifier" }, { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "description": "Get a Tenant group by groupId\n\n**Operation ID:** `getGroup`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully retrieved a group by groupId |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Update a tenant group by groupId", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId/group/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId", "group", ":groupId" ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "Group identifier" }, { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"memberCount\": 0,\n \"createdOn\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"description\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Update a tenant group by groupId\n\n**Operation ID:** `updateGroup`\n\n**Request body:** `TenantGroup` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully updated the group |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Retrieve tenant group members", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId/group/:groupId/member?pageNumber=0&memberId=", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId", "group", ":groupId", "member" ], "query": [ { "key": "pageNumber", "value": "0", "description": "Default: `0` (optional)", "disabled": false }, { "key": "memberId", "value": "", "description": "(optional)", "disabled": true } ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "Group identifier" }, { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "description": "Retrieve tenant group members\n\n**Operation ID:** `getTenantGroupMembers`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns list of group members |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Assign tenant Group membership to user", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId/group/:groupId/member", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId", "group", ":groupId", "member" ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "Group identifier" }, { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"memberId\": \"\",\n \"memberName\": \"\",\n \"groupId\": \"\",\n \"permission\": \"\",\n \"createdOn\": \"\",\n \"note\": \"\",\n \"membershipExpirationDateTime\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Assign tenant Group membership to user\n\n**Operation ID:** `createTenantGroupMember`\n\n**Request body:** `GroupMember` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `201` | Creates Group membership |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `422` | Assignment Already Exists |" }, "response": [] }, { "name": "Deletes tenant group member", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId/group/:groupId/member/:membershipId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId", "group", ":groupId", "member", ":membershipId" ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "Group identifier" }, { "key": "membershipId", "value": "{{membershipId}}", "description": "Group membership identifier" }, { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "description": "Deletes tenant group member\n\n**Operation ID:** `deleteTenantGroupMember`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | Group member Deleted |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Retrieve a tenant group member", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId/group/:groupId/member/:membershipId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId", "group", ":groupId", "member", ":membershipId" ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "Group identifier" }, { "key": "membershipId", "value": "{{membershipId}}", "description": "Group membership identifier" }, { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "description": "Retrieve a tenant group member\n\n**Operation ID:** `getTenantGroupMember`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns Group member |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Not Found |" }, "response": [] }, { "name": "Creates a tenant member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId/member", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId", "member" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"memberId\": \"\",\n \"userName\": \"\",\n \"tenantId\": \"\",\n \"customerId\": \"\",\n \"ssoExempted\": true,\n \"status\": \"\",\n \"createdOn\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates a tenant member\n\n**Operation ID:** `createTenantMember`\n\n**Request body:** `TenantMember` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `201` | Successfully created a tenant member |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `409` | Tenant member Already Exists |" }, "response": [] }, { "name": "Invite a user as a tenant member", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId/member/invite", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId", "member", "invite" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"memberId\": \"\",\n \"userName\": \"\",\n \"tenantId\": \"\",\n \"customerId\": \"\",\n \"ssoExempted\": true,\n \"status\": \"\",\n \"createdOn\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Invite a user as a tenant member\n\n**Operation ID:** `createTenantMemberByInvite`\n\n**Request body:** `TenantMember` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `201` | Invite created Successfully |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `409` | Tenant member Already Exists |" }, "response": [] }, { "name": "Delete a tenant member", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId/member/:memberId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId", "member", ":memberId" ], "variable": [ { "key": "memberId", "value": "{{memberId}}", "description": "Tenant member identifier" }, { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "description": "Delete a tenant member\n\n**Operation ID:** `deleteTenantMember`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | Tenant membership deleted |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Query for a tenant member", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId/member/:memberId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId", "member", ":memberId" ], "variable": [ { "key": "memberId", "value": "{{memberId}}", "description": "Tenant member identifier" }, { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" } ] }, "description": "Query for a tenant member\n\n**Operation ID:** `getTenantMember`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns tenant member |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Not Found |" }, "response": [] }, { "name": "Updates a tenant member", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/tenant/:tenantId/member/:memberId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "tenant", ":tenantId", "member", ":memberId" ], "variable": [ { "key": "tenantId", "value": "{{tenantId}}", "description": "Tenant identifier" }, { "key": "memberId", "value": "{{memberId}}", "description": "Tenant member identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"memberId\": \"\",\n \"userName\": \"\",\n \"tenantId\": \"\",\n \"customerId\": \"\",\n \"ssoExempted\": true,\n \"status\": \"\",\n \"createdOn\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Updates a tenant member\n\n**Operation ID:** `updateTenantMember`\n\n**Request body:** `TenantMember` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully updated a Tenant Member |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `409` | Tenant member Already Exists |" }, "response": [] } ] }, { "name": "IDP SCIM Operations", "description": "Manage IDP users and groups via SCIM operations", "item": [ { "name": "End point to retrieve list of Groups", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/scim2/Groups?startIndex=1&count=30", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "scim2", "Groups" ], "query": [ { "key": "startIndex", "value": "1", "description": "Default: `1` (optional)", "disabled": false }, { "key": "count", "value": "30", "description": "Default: `30` (optional)", "disabled": false } ] }, "description": "End point to retrieve list of Groups\n\n**Operation ID:** `queryUser_2`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully retrieved a list by groups by page number if provided |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Delete a Group by GroupId", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/scim2/Groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "scim2", "Groups", ":id" ], "variable": [ { "key": "id", "value": "{{id}}", "description": "SCIM resource identifier" } ] }, "description": "Delete a Group by GroupId\n\n**Operation ID:** `deleteUser_3`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | No Content |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Get a SCIM group by groupId", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/scim2/Groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "scim2", "Groups", ":id" ], "variable": [ { "key": "id", "value": "{{id}}", "description": "SCIM resource identifier" } ] }, "description": "Get a SCIM group by groupId\n\n**Operation ID:** `get_2`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully retrieved a group by groupId |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Update group members for a groub by Id", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/scim+json" } ], "url": { "raw": "{{baseUrl}}/api/idp/scim2/Groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "scim2", "Groups", ":id" ], "variable": [ { "key": "id", "value": "{{id}}", "description": "SCIM resource identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n ],\n \"Operations\": [\n {\n \"op\": \"\",\n \"path\": \"\",\n \"value\": []\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Update group members for a groub by Id\n\n**Operation ID:** `patchGroup`\n\n**Request body:** `ScimGroupPatch` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully updated group memberships |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |\n| `409` | Record Already Exists |" }, "response": [] }, { "name": "Not Supported. Create a Group", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/scim+json" } ], "url": { "raw": "{{baseUrl}}/api/idp/scim2/Groups/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "scim2", "Groups", ":id" ], "variable": [ { "key": "id", "value": "{{id}}", "description": "SCIM resource identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n ],\n \"displayName\": \"\",\n \"id\": \"\",\n \"meta\": {\n \"resourceType\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\"\n },\n \"members\": [\n {\n \"display\": \"\",\n \"value\": \"\",\n \"$ref\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "description": "Not Supported. Create a Group\n\n**Operation ID:** `upsertGroup`\n\n**Request body:** `ScimGroup` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | OK |" }, "response": [] }, { "name": "Endpoint to query SCIM users. Users can be filtered based of the username or work email", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/scim2/Users?filter=&startIndex=1&count=30", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "scim2", "Users" ], "query": [ { "key": "filter", "value": "", "description": "(optional)", "disabled": true }, { "key": "startIndex", "value": "1", "description": "Default: `1` (optional)", "disabled": false }, { "key": "count", "value": "30", "description": "Default: `30` (optional)", "disabled": false } ] }, "description": "Endpoint to query SCIM users. Users can be filtered based of the username or work email\n\n**Operation ID:** `queryUser_1`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully retrieved a list by groups by page number if provided |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Create a SCIM User", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/scim+json" } ], "url": { "raw": "{{baseUrl}}/api/idp/scim2/Users", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "scim2", "Users" ] }, "body": { "mode": "raw", "raw": "{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"userName\": \"\",\n \"active\": true,\n \"name\": {\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"emails\": [\n {\n \"primary\": true,\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"id\": \"\",\n \"meta\": {\n \"resourceType\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a SCIM User\n\n**Operation ID:** `createUser_2`\n\n**Request body:** `ScimUser` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully created a User |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | User not found |\n| `409` | User Already Exists |" }, "response": [] }, { "name": "Delete a SCIM user by userId", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/scim2/Users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "scim2", "Users", ":id" ], "variable": [ { "key": "id", "value": "{{id}}", "description": "SCIM resource identifier" } ] }, "description": "Delete a SCIM user by userId\n\n**Operation ID:** `deleteUser_2`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | Successfully deleted a User |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | User not found |" }, "response": [] }, { "name": "Get a SCIM user by userId", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/scim2/Users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "scim2", "Users", ":id" ], "variable": [ { "key": "id", "value": "{{id}}", "description": "SCIM resource identifier" } ] }, "description": "Get a SCIM user by userId\n\n**Operation ID:** `get_1`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully retrieved a User by userId |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | User not found |" }, "response": [] }, { "name": "Update a SCIM user by userId", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/scim+json" } ], "url": { "raw": "{{baseUrl}}/api/idp/scim2/Users/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "scim2", "Users", ":id" ], "variable": [ { "key": "id", "value": "{{id}}", "description": "SCIM resource identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"userName\": \"\",\n \"active\": true,\n \"name\": {\n \"familyName\": \"\",\n \"givenName\": \"\"\n },\n \"emails\": [\n {\n \"primary\": true,\n \"value\": \"\",\n \"type\": \"\"\n }\n ],\n \"id\": \"\",\n \"meta\": {\n \"resourceType\": \"\",\n \"created\": \"\",\n \"lastModified\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "description": "Update a SCIM user by userId\n\n**Operation ID:** `upsertUser`\n\n**Request body:** `ScimUser` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully update a User by userId |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | User not found |" }, "response": [] } ] }, { "name": "Group Operations", "description": "Manage Groups and groups memberships", "item": [ { "name": "Retrieve group list", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/group?pageNumber=0&pageSize=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "group" ], "query": [ { "key": "pageNumber", "value": "0", "description": "Default: `0` (optional)", "disabled": false }, { "key": "pageSize", "value": "25", "description": "Default: `25` (optional)", "disabled": false } ] }, "description": "Retrieve group list\n\n**Operation ID:** `getGroup_3`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully retrives the group list |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Create a group", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/group", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "group" ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"memberCount\": 0,\n \"createdOn\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"description\": \"\",\n \"segment\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Create a group\n\n**Operation ID:** `createGroup_1`\n\n**Request body:** `Group` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `201` | Successfully created the group |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Delete a group by groupId", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/group/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "group", ":groupId" ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "Group identifier" } ] }, "description": "Delete a group by groupId\n\n**Operation ID:** `deleteGroup_1`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | Successfully deleted group |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Get a group by groupId", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/group/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "group", ":groupId" ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "Group identifier" } ] }, "description": "Get a group by groupId\n\n**Operation ID:** `getGroup_1`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully retrieved a group by groupId |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Update a group by groupId", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/group/:groupId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "group", ":groupId" ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "Group identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"memberCount\": 0,\n \"createdOn\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"description\": \"\",\n \"segment\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Update a group by groupId\n\n**Operation ID:** `updateGroup_1`\n\n**Request body:** `Group` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Successfully updated the group |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Group not found |" }, "response": [] }, { "name": "Retrieve group members", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/group/:groupId/member?pageNumber=0&pageSize=25&memberId=", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "group", ":groupId", "member" ], "query": [ { "key": "pageNumber", "value": "0", "description": "Default: `0` (optional)", "disabled": false }, { "key": "pageSize", "value": "25", "description": "Default: `25` (optional)", "disabled": false }, { "key": "memberId", "value": "", "description": "(optional)", "disabled": true } ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "Group identifier" } ] }, "description": "Retrieve group members\n\n**Operation ID:** `getGroupMembers`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns list of group members |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Assign Group membership to user", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/group/:groupId/member", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "group", ":groupId", "member" ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "Group identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"memberId\": \"\",\n \"memberName\": \"\",\n \"groupId\": \"\",\n \"permission\": \"\",\n \"createdOn\": \"\",\n \"note\": \"\",\n \"membershipExpirationDateTime\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Assign Group membership to user\n\n**Operation ID:** `createGroupMember`\n\n**Request body:** `GroupMember` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `201` | Creates Group membership |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `422` | Assignment Already Exists |" }, "response": [] }, { "name": "Deletes group member", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/group/:groupId/member/:membershipId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "group", ":groupId", "member", ":membershipId" ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "Group identifier" }, { "key": "membershipId", "value": "{{membershipId}}", "description": "Group membership identifier" } ] }, "description": "Deletes group member\n\n**Operation ID:** `deleteGroupMember`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | Group member Deleted |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Retrieve group member", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/group/:groupId/member/:membershipId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "group", ":groupId", "member", ":membershipId" ], "variable": [ { "key": "groupId", "value": "{{groupId}}", "description": "Group identifier" }, { "key": "membershipId", "value": "{{membershipId}}", "description": "Group membership identifier" } ] }, "description": "Retrieve group member\n\n**Operation ID:** `getGroupMember`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns Group member |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Not Found |" }, "response": [] } ] }, { "name": "Application", "description": "List and Manage Application Assignments", "item": [ { "name": "List all the applications", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/application?type=&pageNumber=0&pageSize=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "application" ], "query": [ { "key": "type", "value": "", "description": "Optional parameter for filtering applications by type. Supported Values SAML, OIDC_CLIENT, OIDC_SERVER, OAUTH2_CLIENT, OAUTH2_SERVER, OAUTH2_CLIENTCRED (optional)", "disabled": true }, { "key": "pageNumber", "value": "0", "description": "Default: `0` (optional)", "disabled": false }, { "key": "pageSize", "value": "25", "description": "Default: `25` (optional)", "disabled": false } ] }, "description": "List all the applications\n\n**Operation ID:** `getApplication`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns list of applications |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Retrieve application assignments", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/application/:applicationId/assignment?pageNumber=0&pageSize=25", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "application", ":applicationId", "assignment" ], "query": [ { "key": "pageNumber", "value": "0", "description": "Default: `0` (optional)", "disabled": false }, { "key": "pageSize", "value": "25", "description": "Default: `25` (optional)", "disabled": false } ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "Application identifier" } ] }, "description": "Retrieve application assignments\n\n**Operation ID:** `getApplicationAssignees`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns list of application assignments |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Creates application assignment", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/application/:applicationId/assignment", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "application", ":applicationId", "assignment" ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "Application identifier" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"applicationId\": \"\",\n \"assigneeType\": \"\",\n \"assigneeId\": \"\",\n \"createdBy\": \"\",\n \"updatedBy\": \"\",\n \"createdOn\": \"\",\n \"updatedOn\": \"\",\n \"assignmentExpirationDateTime\": \"\",\n \"assignmentNote\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "Creates application assignment\n\n**Operation ID:** `createApplicationAssignment`\n\n**Request body:** `ApplicationAssignment` \u2014 the sample below is generated from the published model, so optional fields may need removing.\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `201` | Creates Application Assignment |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `422` | Assignment Already Exists |" }, "response": [] }, { "name": "Deletes application assignment", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/application/:applicationId/assignment/:assignmentId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "application", ":applicationId", "assignment", ":assignmentId" ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "Application identifier" }, { "key": "assignmentId", "value": "{{assignmentId}}", "description": "Application assignment identifier" } ] }, "description": "Deletes application assignment\n\n**Operation ID:** `deleteApplicationAssignment`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `204` | Application Assignment Deleted |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Retrieve application assignment", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/application/:applicationId/assignment/:assignmentId", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "application", ":applicationId", "assignment", ":assignmentId" ], "variable": [ { "key": "applicationId", "value": "{{applicationId}}", "description": "Application identifier" }, { "key": "assignmentId", "value": "{{assignmentId}}", "description": "Application assignment identifier" } ] }, "description": "Retrieve application assignment\n\n**Operation ID:** `getApplicationAssignee`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns application Assignment |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] } ] }, { "name": "Meta Data APIs", "description": "Query and list roles, scopes, and user schema", "item": [ { "name": "Retrieves list of roles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/role?type=GLOBAL", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "role" ], "query": [ { "key": "type", "value": "GLOBAL", "description": "Optional parameter, defaults to GLOBAL. Supported Values GROBAL, RESOURCE Default: `GLOBAL` (optional)", "disabled": false } ] }, "description": "Retrieves list of roles\n\n**Operation ID:** `getRoles`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns the list of roles |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Retrieves scopes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/scope?namespace=", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "scope" ], "query": [ { "key": "namespace", "value": "", "description": "Optional parameter, Allows to filter scopes for a particular namespace (optional)", "disabled": true } ] }, "description": "Retrieves scopes\n\n**Operation ID:** `getScopes`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns the list of scopes |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Retrieves scope details for a scope", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/scope/:scopeName", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "scope", ":scopeName" ], "variable": [ { "key": "scopeName", "value": "{{scopeName}}", "description": "Scope name" } ] }, "description": "Retrieves scope details for a scope\n\n**Operation ID:** `getScopeDetail`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns the details including the resource and permissions assigned to scope |\n| `400` | Bad Request |\n| `403` | Not Authorized |\n| `404` | Not Authorized |" }, "response": [] }, { "name": "Retrieves user schema for a given user category", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/user/schema?category=customer", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "user", "schema" ], "query": [ { "key": "category", "value": "customer", "description": "Optional parameter, defaults to Customer. Supported Values CUSTOMER, EMPLOYEE Default: `customer` (optional)", "disabled": false } ] }, "description": "Retrieves user schema for a given user category\n\n**Operation ID:** `getSchema_1`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns the list of user attributes for a given user category |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] }, { "name": "Retrieves list of roles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/:resourceId/role", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", ":resourceId", "role" ], "variable": [ { "key": "resourceId", "value": "{{resourceId}}", "description": "Resource identifier" } ] }, "description": "Retrieves list of roles\n\n**Operation ID:** `getResourceRoles`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | Returns the list of roles for a given resourceId |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] } ] }, { "name": "Test Automation", "description": "Query the Email or SMS OTP code for Test Users", "item": [ { "name": "Query a OTP code for Test User", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/idp/user/test/otp?email=&phone=", "host": [ "{{baseUrl}}" ], "path": [ "api", "idp", "user", "test", "otp" ], "query": [ { "key": "email", "value": "", "description": "Optional parameter (optional)", "disabled": true }, { "key": "phone", "value": "", "description": "Optional parameter (optional)", "disabled": true } ] }, "description": "Query a OTP code for Test User\n\n**Operation ID:** `getTestUserOtp`\n\n**Responses**\n\n| Code | Meaning |\n|---|---|\n| `200` | OPT code |\n| `400` | Bad Request |\n| `403` | Not Authorized |" }, "response": [] } ] } ], "variable": [ { "key": "baseUrl", "value": "https://b.cell.webfrolic.com", "type": "string" }, { "key": "token", "value": "", "type": "string", "description": "Credential sent as the bearer token. The published spec does not name its security scheme \u2014 confirm with your WebFrolic administrator and adjust the collection Authorization tab if it differs." }, { "key": "applicationId", "value": "", "type": "string", "description": "Application identifier" }, { "key": "assignmentId", "value": "", "type": "string", "description": "Application assignment identifier" }, { "key": "customerId", "value": "", "type": "string", "description": "Customer identifier used by the session endpoints" }, { "key": "groupId", "value": "", "type": "string", "description": "Group identifier" }, { "key": "id", "value": "", "type": "string", "description": "SCIM resource identifier" }, { "key": "memberId", "value": "", "type": "string", "description": "Tenant member identifier" }, { "key": "membershipId", "value": "", "type": "string", "description": "Group membership identifier" }, { "key": "resourceId", "value": "", "type": "string", "description": "Resource identifier" }, { "key": "scopeName", "value": "", "type": "string", "description": "Scope name" }, { "key": "sessionId", "value": "", "type": "string", "description": "Session identifier" }, { "key": "tenantId", "value": "", "type": "string", "description": "Tenant identifier" }, { "key": "userId", "value": "", "type": "string", "description": "User identifier" } ] }