{
  "opencollection": "1.0.0",
  "info": {
    "name": "User and Access Management Organization Roles API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "organization-roles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Returns the list of organization roles.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/organization-roles",
            "params": [
              {
                "name": "roleKey",
                "value": "",
                "type": "query",
                "description": "Organization role key."
              },
              {
                "name": "nameContains",
                "value": "",
                "type": "query",
                "description": "Filters list by name."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Used for sorting the list. Ascending by default. Prepend a hyphen, \"-\", to get a descending sort, for example \"-name\". The default is name. Allowed: name."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results returned. The value must be within 1 - 100 (both inclusive). The default value is 100."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Starting point or position of the first result returned. The default value is 0."
              }
            ]
          },
          "docs": "Returns a list of organization roles. Use query parameters to filter the result based on different criteria.\n\nAPI client must have at least one permission."
        },
        {
          "info": {
            "name": "Create an organization role.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/organization-roles",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates an organization role.\n\nAPI Client needs the **User management > Manage organization roles** permission."
        },
        {
          "info": {
            "name": "Returns information for an organization role.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/organization-roles/:key",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Organization role key."
              }
            ]
          },
          "docs": "Returns details about an organization role based on the organization role key.\n\nAPI client must have at least one permission."
        },
        {
          "info": {
            "name": "Update an organization role.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/organization-roles/:key",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Organization role key."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the details of an organization role based on the organization role key.\n\nAPI Client needs the **User management > Manage organization roles** permission."
        },
        {
          "info": {
            "name": "Delete an organization role.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/organization-roles/:key",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Organization role key."
              }
            ]
          },
          "docs": "Deletes an organization role.\n\nAPI Client needs the **User management > Manage organization roles** permission."
        },
        {
          "info": {
            "name": "Returns a list of users with a specific organization role.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/organization-roles/:key/users",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Organization role key."
              },
              {
                "name": "nameOrEmailContains",
                "value": "",
                "type": "query",
                "description": "Filters list by name or email. Parameter value must be URL-encoded (percent-encoding) to ensure it's correctly interpreted by the server. Example: Searching for an email with a +\n            \n Incorrect: .../users?email=`john+doe@example.com`.\n            \n Correct: .../users?email=`john%2Bdoe@example.com`"
              },
              {
                "name": "nameOrEmailOrUsernameContains",
                "value": "",
                "type": "query",
                "description": "Filters list by name, email, or username. Parameter value must be URL-encoded (percent-encoding) to ensure it's correctly interpreted by the server. Example: Searching for an email with a +\n            \n Incorrect: .../users?email=`john+doe@example.com`.\n            \n Correct: .../users?email=`john%2Bdoe@example.com`"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results returned. The value must be within 1 - 100 (both inclusive). The default value is 100."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Starting point or position of the first result returned. The default value is 0."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Used for sorting the list. Ascending by default. Prepend a hyphen, \"-\", to get a descending sort, for example \"-name\". The default is name. Allowed: userKey, name, email, status, lastLoginAt."
              },
              {
                "name": "embed",
                "value": "",
                "type": "query",
                "description": "List of fields to embed in the response."
              }
            ]
          },
          "docs": "Returns a list of users with a specific organization role, based on the organization role key.\nUse query parameters to filter the result based on different criteria.\n\nAPI Client needs the **User management > View members** permission."
        }
      ]
    }
  ],
  "bundled": true
}