{ "opencollection": "1.0.0", "info": { "name": "Coveo Activity Activities Saml Identity Providers API", "version": "1.0.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.cloud.coveo.com/oauth/authorize", "accessTokenUrl": "https://platform.cloud.coveo.com/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Saml Identity Providers", "type": "folder" }, "items": [ { "info": { "name": "Show Identity Provider", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/saml/identityprovider", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The [unique identifier of the organization](https://docs.coveo.com/en/n1ce5273/manage-an-organization/find-your-organization-id) for which to show the identity provider.
**Example:** `mycoveocloudorganizationg8tp8wu3`" } ] }, "docs": "Shows the SAML identity provider of an [organization](https://docs.coveo.com/en/185/).
**Required privilege:** SAML identity provider - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SAML_IDENTITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Create Identity Provider", "type": "http" }, "http": { "method": "POST", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/saml/identityprovider", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an identity provider for an [organization](https://docs.coveo.com/en/185/).
**Required privilege:** SAML identity provider - Create

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SAML_IDENTITY_PROVIDER\",\"type\":\"CREATE\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Update Identity Provider", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/saml/identityprovider", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a SAML identity provider of an [organization](https://docs.coveo.com/en/185/).
**Required privilege:** SAML identity provider - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SAML_IDENTITY_PROVIDER\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Delete Identity Provider", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/saml/identityprovider", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The [unique identifier of the organization](https://docs.coveo.com/en/n1ce5273/manage-an-organization/find-your-organization-id) for which to delete the SAML identity provider.
**Example:** `mycoveocloudorganizationg8tp8wu3`" } ] }, "docs": "Deletes the identity provider of an [organization](https://docs.coveo.com/en/185/).
**Required privilege:** SAML identity provider - Edit

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SAML_IDENTITY_PROVIDER\",\"type\":\"EDIT\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "List Identity Provider Realms", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/saml/identityprovider/realms", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The [unique identifier of the organization](https://docs.coveo.com/en/n1ce5273/manage-an-organization/find-your-organization-id) for which to list realms.
**Example:** `mycoveocloudorganizationg8tp8wu3`" } ] }, "docs": "Lists the realms of a SAML identity provider.

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SAML_IDENTITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "Check If Any Identity Provider Exists", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/saml/enabled", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "docs": "Checks if any SAML identity provider exists in an [organization](https://docs.coveo.com/en/185/).
**Required privilege:** Organization - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"ORGANIZATION\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" }, { "info": { "name": "List Manageable Identity Providers", "type": "http" }, "http": { "method": "GET", "url": "https://platform.cloud.coveo.com/rest/organizations/:organizationId/saml/availables", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "The unique identifier of the target [organization](https://docs.coveo.com/en/185/).
**Example:** `mycoveocloudv2organizationg8tp8wu3`" } ] }, "docs": "List SAML identity providers that the current user can manage.
**Required privilege:** SAML identity provider - View

Privilege required\n```\n{\"owner\":\"PLATFORM\",\"targetDomain\":\"SAML_IDENTITY_PROVIDER\",\"type\":\"VIEW\",\"targetId\":\"*\"}\n```\n
" } ] } ], "bundled": true }