@servicenow/sdk - v4.13.3
    Preparing search index...

    Variable sys_user_roleConst

    sys_user_role: {
        allowWebServiceAccess: true;
        attributes: {
            "all_tables.text_index_translations": true;
            iterativeDelete: true;
            no_table_trace: true;
            update_synch: true;
        };
        extends: "sys_metadata";
        label: "Role";
        name: "sys_user_role";
        schema: {
            assignable_by: Typed<
                | string
                | Record<"sys_user_role">
                | ExplicitKey<"sys_user_role">
                | TableBrand<"sys_user_role">,
                {
                    label: [
                        {
                            hint: "If the related application has Scoped administration enabled, a user needs to have the 'Assignable By' role to be able to assign this role to another user";
                            label: "Assignable by";
                            plural: "Assignable by";
                        },
                    ];
                    referenceQual: "javascript:if (gs.hasRole('admin')) 'sys_scope!=global'; else 'sys_scope=' + current.sys_scope;";
                    referenceTable: "sys_user_role";
                },
            >;
            can_delegate: Typed<
                boolean,
                {
                    default: true;
                    label: [
                        {
                            hint: "Can be delegated";
                            label: "Can delegate";
                            plural: "Can delegates";
                        },
                    ];
                },
            >;
            description: Typed<
                string,
                {
                    attributes: { no_truncate: true };
                    label: "Description";
                    maxLength: 1000;
                },
            >;
            elevated_privilege: Typed<
                boolean,
                {
                    default: false;
                    label: [
                        {
                            hint: "This role is an elevated privilege";
                            label: "Elevated privilege";
                            plural: "Elevated privileges";
                        },
                    ];
                },
            >;
            federated_id: Typed<
                string,
                {
                    attributes: { edge_encryption_enabled: true };
                    label: "Federated Role ID";
                    maxLength: 100;
                },
            >;
            grantable: Typed<
                boolean,
                {
                    default: true;
                    label: [
                        {
                            hint: "Can be granted independently";
                            label: "Grantable";
                            plural: "Grantables";
                        },
                    ];
                },
            >;
            includes_roles: Typed<string, { array: true; label: "Includes roles" }>;
            name: Typed<string, { label: "Name"; maxLength: 100; unique: true }>;
            scoped_admin: Typed<
                boolean,
                {
                    default: false;
                    label: [
                        {
                            hint: "If this is an Application Administrator role";
                            label: "Application Administrator";
                            plural: "Application Administrators";
                        },
                    ];
                },
            >;
            suffix: Typed<string, { label: "Suffix"; maxLength: 100 }>;
        };
        textIndex: true;
    } = ...

    Type Declaration

    • ReadonlyallowWebServiceAccess: true
    • Readonlyattributes: {
          "all_tables.text_index_translations": true;
          iterativeDelete: true;
          no_table_trace: true;
          update_synch: true;
      }
    • Readonlyextends: "sys_metadata"
    • Readonlylabel: "Role"
    • Readonlyname: "sys_user_role"
    • Readonlyschema: {
          assignable_by: Typed<
              | string
              | Record<"sys_user_role">
              | ExplicitKey<"sys_user_role">
              | TableBrand<"sys_user_role">,
              {
                  label: [
                      {
                          hint: "If the related application has Scoped administration enabled, a user needs to have the 'Assignable By' role to be able to assign this role to another user";
                          label: "Assignable by";
                          plural: "Assignable by";
                      },
                  ];
                  referenceQual: "javascript:if (gs.hasRole('admin')) 'sys_scope!=global'; else 'sys_scope=' + current.sys_scope;";
                  referenceTable: "sys_user_role";
              },
          >;
          can_delegate: Typed<
              boolean,
              {
                  default: true;
                  label: [
                      {
                          hint: "Can be delegated";
                          label: "Can delegate";
                          plural: "Can delegates";
                      },
                  ];
              },
          >;
          description: Typed<
              string,
              {
                  attributes: { no_truncate: true };
                  label: "Description";
                  maxLength: 1000;
              },
          >;
          elevated_privilege: Typed<
              boolean,
              {
                  default: false;
                  label: [
                      {
                          hint: "This role is an elevated privilege";
                          label: "Elevated privilege";
                          plural: "Elevated privileges";
                      },
                  ];
              },
          >;
          federated_id: Typed<
              string,
              {
                  attributes: { edge_encryption_enabled: true };
                  label: "Federated Role ID";
                  maxLength: 100;
              },
          >;
          grantable: Typed<
              boolean,
              {
                  default: true;
                  label: [
                      {
                          hint: "Can be granted independently";
                          label: "Grantable";
                          plural: "Grantables";
                      },
                  ];
              },
          >;
          includes_roles: Typed<string, { array: true; label: "Includes roles" }>;
          name: Typed<string, { label: "Name"; maxLength: 100; unique: true }>;
          scoped_admin: Typed<
              boolean,
              {
                  default: false;
                  label: [
                      {
                          hint: "If this is an Application Administrator role";
                          label: "Application Administrator";
                          plural: "Application Administrators";
                      },
                  ];
              },
          >;
          suffix: Typed<string, { label: "Suffix"; maxLength: 100 }>;
      }
    • ReadonlytextIndex: true