Roles

GET Get Roles

GET /organizations/{organizationId}/roles

Operation ID: getRoles. Security: AmOAuth2 (sfcc.roles, sfcc.roles.rw).

Retrieves all access roles with no filtering.

Parameters

• organizationId (path, OrganizationId, required) An identifier for the organization the request is being made by

  Example

  f_ecom_zzxy_prd

• expand (query, array of string, style: form, explode: false) The list of resource types to include in the response.
  Items: Allowed values: users, permissions. Example: users.
• select (query, Select)

  Example: select

  (**)

• limit (query, integer (int32)) Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 25.
  Default: 25. Minimum: 1. Maximum: 200.
• offset (query, integer (int32)) Used to retrieve the results based on a particular resource offset.
  Default: 0. Minimum: 0.

Responses

• 200 Returns the collection of access roles

  Media type: application/json. Schema: RoleSearch.

  Example: RoleSearchResult Role search result

  Example of a role search response. By default, only IDs are returned.

  {
    "limit": 3,
    "offset": 0,
    "total": 3,
    "data": [
      {
        "id": "Administrator"
      },
      {
        "id": "CustomManager"
      },
      {
        "id": "ContentEditor"
      }
    ]
  }

  Example: RoleSearchExpandUsersResult Role search with expand users

  Example of a role search response with expand=users and select=(**). All role fields are returned and each role includes its full users.

  {
    "limit": 3,
    "offset": 0,
    "total": 3,
    "data": [
      {
        "id": "Administrator",
        "description": "Full administrative access to Business Manager",
        "userCount": 2,
        "userManager": true,
        "users": [
          {
            "login": "admin-user",
            "email": "admin@example.com",
            "firstName": "John",
            "lastName": "Doe",
            "externalId": "ext-12345",
            "disabled": false,
            "locked": false,
            "lastLoginDate": "2024-10-14",
            "passwordExpirationDate": "2025-01-14T00:00:00.000Z",
            "passwordModificationDate": "2024-10-14T10:00:00.000Z",
            "preferredDataLocale": "en-US",
            "preferredUiLocale": "en-US",
            "roles": [
              "Administrator"
            ]
          }
        ]
      },
      {
        "id": "CustomManager",
        "description": "Custom manager role for site operations",
        "userCount": 5,
        "userManager": false,
        "users": [
          {
            "login": "manager-user",
            "email": "manager@example.com",
            "firstName": "Alice",
            "lastName": "Brown",
            "externalId": "ext-11111",
            "disabled": false,
            "locked": false,
            "lastLoginDate": "2024-12-01",
            "passwordExpirationDate": "2025-03-01T00:00:00.000Z",
            "passwordModificationDate": "2024-12-01T09:00:00.000Z",
            "preferredDataLocale": "en-US",
            "preferredUiLocale": "en-US",
            "roles": [
              "CustomManager"
            ]
          }
        ]
      },
      {
        "id": "ContentEditor",
        "description": "Content editing access",
        "userCount": 8,
        "userManager": false,
        "users": [
          {
            "login": "editor-user",
            "email": "editor@example.com",
            "firstName": "Jane",
            "lastName": "Smith",
            "externalId": "ext-67890",
            "disabled": false,
            "locked": false,
            "lastLoginDate": "2024-11-20",
            "passwordExpirationDate": "2025-02-20T00:00:00.000Z",
            "passwordModificationDate": "2024-11-20T08:30:00.000Z",
            "preferredDataLocale": "en-US",
            "preferredUiLocale": "en-US",
            "roles": [
              "ContentEditor"
            ]
          }
        ]
      }
    ]
  }

  Example: RoleSearchExpandPermissionsResult Role search with expand permissions

  Example of a role search response with expand=permissions and select=(**). All role fields are returned and each role includes its full permissions.

  {
    "limit": 3,
    "offset": 0,
    "total": 3,
    "data": [
      {
        "id": "Administrator",
        "description": "Full administrative access to Business Manager",
        "userCount": 2,
        "userManager": true,
        "permissions": {
          "module": {
            "organization": [
              {
                "name": "jobschedules",
                "application": "bm",
                "system": true,
                "type": "module",
                "value": "ACCESS"
              },
              {
                "name": "customreports",
                "application": "bm",
                "system": false,
                "type": "module",
                "value": "ACCESS"
              }
            ],
            "site": [
              {
                "name": "library_content",
                "application": "bm",
                "system": true,
                "type": "module",
                "values": {
                  "SiteGenesis": "ACCESS",
                  "RefArch": "READONLY"
                }
              }
            ]
          },
          "functional": {
            "organization": [
              {
                "name": "Delete_All_Catalogs",
                "type": "functional",
                "value": "ACCESS"
              }
            ],
            "site": [
              {
                "name": "ViewOrders",
                "type": "functional",
                "values": {
                  "SiteGenesis": "ACCESS"
                }
              }
            ]
          },
          "locale": {
            "unscoped": [
              {
                "localeId": "default",
                "type": "locale",
                "value": "ACCESS"
              },
              {
                "localeId": "en",
                "type": "locale",
                "value": "ACCESS"
              }
            ]
          },
          "webdav": {
            "unscoped": [
              {
                "folder": "/catalogs/apparel-catalog",
                "type": "webdav",
                "value": "ACCESS"
              }
            ]
          }
        }
      },
      {
        "id": "CustomManager",
        "description": "Custom manager role for site operations",
        "userCount": 5,
        "userManager": false,
        "permissions": {
          "module": {
            "site": [
              {
                "name": "library_content",
                "application": "bm",
                "system": true,
                "type": "module",
                "values": {
                  "SiteGenesis": "ACCESS"
                }
              }
            ]
          },
          "locale": {
            "unscoped": [
              {
                "localeId": "default",
                "type": "locale",
                "value": "ACCESS"
              }
            ]
          },
          "webdav": {
            "unscoped": []
          }
        }
      },
      {
        "id": "ContentEditor",
        "description": "Content editing access",
        "userCount": 8,
        "userManager": false,
        "permissions": {
          "module": {
            "site": [
              {
                "name": "library_content",
                "application": "bm",
                "system": true,
                "type": "module",
                "values": {
                  "SiteGenesis": "READONLY"
                }
              }
            ]
          },
          "locale": {
            "unscoped": [
              {
                "localeId": "default",
                "type": "locale",
                "value": "ACCESS"
              },
              {
                "localeId": "en",
                "type": "locale",
                "value": "READONLY"
              }
            ]
          },
          "webdav": {
            "unscoped": []
          }
        }
      }
    ]
  }