{
  "opencollection": "1.0.0",
  "info": {
    "name": "User and Access Management Groups API",
    "version": "v1"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "groups",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Returns a list of users associated with a group.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/groups/:key/users",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "The group's key."
              },
              {
                "name": "userKey",
                "value": "",
                "type": "query",
                "description": "The user's key. Mutually exclusive with `userKeys`."
              },
              {
                "name": "userKeys",
                "value": "",
                "type": "query",
                "description": "Only returns the users matching any of the specified keys. Comma-separated list of user keys. Mutually exclusive with `userKey`."
              },
              {
                "name": "nameOrEmailContains",
                "value": "",
                "type": "query",
                "description": "Filters users by name or email address. 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 users by name or 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": "lastLoginAtSince",
                "value": "",
                "type": "query",
                "description": "Only returns users whose last login occurred on or after the specified date and time."
              },
              {
                "name": "lastLoginAtTo",
                "value": "",
                "type": "query",
                "description": "Only returns users whose last login occurred before or on the specified date and time."
              },
              {
                "name": "membershipType",
                "value": "",
                "type": "query",
                "description": "Filters users by membership type that can be `Assigned` or `Mapped`."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results returned. Allowed values: 1 to 100 Default value: 100."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset of the first result returned. Default value: 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\". Default: name. Allowed: key, name, email, status, lastLoginAt."
              },
              {
                "name": "embed",
                "value": "",
                "type": "query",
                "description": "List of fields to embed in the response."
              }
            ]
          },
          "docs": "Returns a list of users associated with a group that match the specified filters. Use query parameters to refine the search.\n\nAPI Client needs the **User management > Manage end-user groups** permission."
        },
        {
          "info": {
            "name": "Allow to add or remove users from a group.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/groups/:key/users",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "The group key."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Allows adding or removing users from a specified group. Manage group membership by specifying the group key and providing lists of user keys to be added or removed.\n\nAPI Client needs the **User management > Manage end-user groups** permission."
        },
        {
          "info": {
            "name": "Returns the list of groups based on specified conditions.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/groups",
            "params": [
              {
                "name": "nameContains",
                "value": "",
                "type": "query",
                "description": "Filters users by name."
              },
              {
                "name": "environmentKey",
                "value": "",
                "type": "query",
                "description": "Only returns groups associated with the specified environment (stage). Mutually exclusive with `environmentKeys`."
              },
              {
                "name": "environmentKeys",
                "value": "",
                "type": "query",
                "description": "Only returns groups associated with any of the specified environments (stages). Comma-separated list of environment keys. Mutually exclusive with `environmentKey`."
              },
              {
                "name": "identityProviderKey",
                "value": "",
                "type": "query",
                "description": "Only returns groups with claim mappings for the specified identity provider."
              },
              {
                "name": "portfolioKeys",
                "value": "",
                "type": "query",
                "description": "Only returns groups in environments belonging to any of the specified portfolios."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results returned. Allowed values: 1 to 100 Default value: 100."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset of the first result returned. Default value: 0."
              }
            ]
          },
          "docs": "Returns a list of groups that match the specified filters. Use query parameters to refine the search.\n\nAPI Client needs the **User management > Manage end-user groups** permission."
        },
        {
          "info": {
            "name": "Creates a new group.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/groups",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new group by specifying a name and environment (stage). Optionally, you can include a list of users and application roles to assign to the group during creation.\n\nAPI Client needs the **User management > Manage end-user groups** permission."
        },
        {
          "info": {
            "name": "Returns information for a group.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/groups/:key",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "Group key."
              }
            ]
          },
          "docs": "Retrieves detailed information about a group, including its name, description, and environment.\n\nAPI Client needs the **User management > Manage end-user groups** permission."
        },
        {
          "info": {
            "name": "Updates a group.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/groups/:key",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "The key of the group to be updated."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the details of a group using the group's key. Allows modification of the group's name or description.\n\nAPI Client needs the **User management > Manage end-user groups** permission."
        },
        {
          "info": {
            "name": "Deletes a group.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/groups/:key",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "The key of the group to be deleted."
              }
            ]
          },
          "docs": "Deletes a specified group using the group's key.\n\nAPI Client needs the **User management > Manage end-user groups** permission."
        },
        {
          "info": {
            "name": "Returns a list of application roles associated with a group.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/groups/:key/application-roles",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "The group key."
              },
              {
                "name": "assetKey",
                "value": "",
                "type": "query",
                "description": "The asset key."
              },
              {
                "name": "applicationRoleKey",
                "value": "",
                "type": "query",
                "description": "The application role key. Mutually exclusive with `applicationRoleKeys`."
              },
              {
                "name": "applicationRoleKeys",
                "value": "",
                "type": "query",
                "description": "Only returns the application roles matching any of the specified keys. Comma-separated list of application role keys. Mutually exclusive with `applicationRoleKey`."
              },
              {
                "name": "nameContains",
                "value": "",
                "type": "query",
                "description": "Filters application roles by name."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results returned. Allowed values: 1 to 100 Default value: 100."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset of the first result returned. Default value: 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\". Default: name. Allowed: name, assetkey."
              }
            ]
          },
          "docs": "Returns a list of application roles that match the specified filters. Use query parameters to refine the search.\n\nAPI Client needs the **User management > Manage end-user groups** permission."
        },
        {
          "info": {
            "name": "Allow to add or remove application roles from a group.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/groups/:key/application-roles",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "The group key."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Allows adding or removing application roles from a specified group. Manage roles by specifying the group key and providing lists of application role keys to be added or removed.\n\nAPI Client needs the **User management > Manage end-user groups** permission."
        },
        {
          "info": {
            "name": "Delete a Group Idp Mapping.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://ODC_PORTAL_DOMAIN/api/identity/v1/groups/:key/claim-mappings/:mappingKey",
            "params": [
              {
                "name": "key",
                "value": "",
                "type": "path",
                "description": "The key of the Group for the Idp Mapping object to delete."
              },
              {
                "name": "mappingKey",
                "value": "",
                "type": "path",
                "description": "Claim Mapping key."
              }
            ]
          },
          "docs": "Delete a specified Group Idp Mapping object using its key.\n\nAPI Client needs the **User management > Manage end-user groups** permission."
        }
      ]
    }
  ],
  "bundled": true
}