{
  "opencollection": "1.0.0",
  "info": {
    "name": "Secret Server Rest Activations SecretPermissions API",
    "version": "11.7.2"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "SecretPermissions",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Secret Permission",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/secret-permissions/:id",
            "params": [
              {
                "name": "includeInactive",
                "value": "",
                "type": "query",
                "description": "Whether to include inactive permissions in the results"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Secret permission ID"
              }
            ]
          },
          "docs": "Get a single secret permission by ID"
        },
        {
          "info": {
            "name": "Update Secret Permission",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/SecretServer/api/v1/secret-permissions/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Secret permission ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a single secret permission by ID"
        },
        {
          "info": {
            "name": "Delete Secret Permission",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/SecretServer/api/v1/secret-permissions/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Secret permission ID"
              }
            ]
          },
          "docs": "Delete a secret permission by ID"
        },
        {
          "info": {
            "name": "Search Secret Permissions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/secret-permissions",
            "params": [
              {
                "name": "filter.domainId",
                "value": "",
                "type": "query",
                "description": "DomainId"
              },
              {
                "name": "filter.domainName",
                "value": "",
                "type": "query",
                "description": "DomainName"
              },
              {
                "name": "filter.groupId",
                "value": "",
                "type": "query",
                "description": "Filter by group ID"
              },
              {
                "name": "filter.groupName",
                "value": "",
                "type": "query",
                "description": "GroupName"
              },
              {
                "name": "filter.searchText",
                "value": "",
                "type": "query",
                "description": "SearchText"
              },
              {
                "name": "filter.secretId",
                "value": "",
                "type": "query",
                "description": "Filter by secret ID"
              },
              {
                "name": "filter.userId",
                "value": "",
                "type": "query",
                "description": "Filter by user ID"
              },
              {
                "name": "filter.userName",
                "value": "",
                "type": "query",
                "description": "UserName"
              },
              {
                "name": "skip",
                "value": "",
                "type": "query",
                "description": "Number of records to skip before taking results"
              },
              {
                "name": "sortBy[0].direction",
                "value": "",
                "type": "query",
                "description": "Sort direction"
              },
              {
                "name": "sortBy[0].name",
                "value": "",
                "type": "query",
                "description": "Sort field name"
              },
              {
                "name": "sortBy[0].priority",
                "value": "",
                "type": "query",
                "description": "Priority index. Sorts with lower values are executed earlier"
              },
              {
                "name": "take",
                "value": "",
                "type": "query",
                "description": "Maximum number of records to include in results"
              }
            ]
          },
          "docs": "Search, filter, sort, and page secret permissions"
        },
        {
          "info": {
            "name": "Create Secret Permission",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/SecretServer/api/v1/secret-permissions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new secret permission"
        },
        {
          "info": {
            "name": "Get Secret Permission Stub",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/secret-permissions/stub",
            "params": [
              {
                "name": "secretId",
                "value": "",
                "type": "query",
                "description": "Options for generating a secret permission stub"
              }
            ]
          },
          "docs": "Return the default values for a new secret permission"
        },
        {
          "info": {
            "name": "Gets the possible role options for a secret",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/secret-permissions/role-options"
          },
          "docs": "Gets the possible role options for a secret"
        },
        {
          "info": {
            "name": "Get Secret Permission for Platform Service User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/SecretServer/api/v1/secret-permissions/platform-permission",
            "params": [
              {
                "name": "aclRoleName",
                "value": "",
                "type": "query",
                "description": "ACL Role name of role to check or assign to secret."
              },
              {
                "name": "secretId",
                "value": "",
                "type": "query",
                "description": "Secret Id to check or assign role for a user."
              },
              {
                "name": "userName",
                "value": "",
                "type": "query",
                "description": "Username of user to check or assign role on secret."
              }
            ]
          },
          "docs": "Gets a value indicating whether access is granted to a designated platform service user"
        },
        {
          "info": {
            "name": "Grants level of access for a platform service account on a secret",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/SecretServer/api/v1/secret-permissions/platform-permission",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Grants level of access for a platform service account on a secret"
        },
        {
          "info": {
            "name": "Update Secret share inherit",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/SecretServer/api/v1/secrets/:secretId/share",
            "params": [
              {
                "name": "secretId",
                "value": "",
                "type": "path",
                "description": "Secret ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a single secret for share inheritance"
        },
        {
          "info": {
            "name": "Check Current User is Owner",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/SecretServer/api/v1/secret-permissions/is-current-user-secret-owner",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Check if the current user is a Secret Owner using the submitted Permissions."
        }
      ]
    }
  ],
  "bundled": true
}