ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
appID string The unique identifier of Connected Application
riskLevel string The risk level associated with the Connected Application.
permissionsMetadata list<object> Metadata for each permission associated with the Connected Application.
 name string Name of the permission.
 riskLevel string Risk level of the permission.
 firstSeenTime number Timestamp when the permission was first seen.
 removedTime number Timestamp when the permission was removed (0 if not removed).
 riskScore number Risk score of the permission. Not present when riskLevel is Unknown.
connectedAppName string Name of the Connected Application.
riskScore number The risk score associated with the Connected Application.
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
sys_tags string The sys tags associated with the OAuthCredential.
sys_id string Represents the resource id of the OAuthCredential.
sys_created_on number Data and time the associated OAuthCredential was originally created.
last_access string The last access
requestor_id string The id of the requestor.
sys_mod_count string Number of times that the associated OAuthCredential record has been modified.
peer object The associated OAuthEntity.
 link string Link to OAuthEntity.
 value string The ID of the resource oauth entity to which access is authorized.
scopes string The scope associated with OAuthCredential (usually useraccount).
peer.name string The name of the OAuthEntity to which access is authorized.
expires number Data and time the grant to associated ConnectedApp expires.
type string The type OAuth grant like Access Token, Refresh Token, Authorization Code, etc.
sys_updated_by string User that last updated the associated OAuthCredential information.
oauth_requestor_profile string The oauth requestor profile.
code_challenge_method string The method defined code challenge associated with the OAuthCredential.
session_user string The session user.
user object The associated User.
 link string Link to User.
 value string The ID of the user on behalf of whom the client is authorized to access the resource.
sys_created_by string User that originally created the associated User record.
code_challenge string The code challenge associated with the OAuthCredential.
peer.type string The type of the OAuthEntity to which access is authorized.
roles list<string> The roles of the user that corresponds to OAuthEntity(ConnectedApp) permissions.
login_method string The login method.
sys_updated_on number Data and time the associated OAuthCredential information was updated.
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
sys_name string Name of the OAuthEntity.
sys_id string Represents the resource id of the OAuthEntity.
login_url string The login url.
restricted_binding boolean Flag that indicates if the OAuthEntity has restricted binding.
auth_url string Auth url.
default_grant_type string Indicates the default grant type.
auth_code_lifespan number auth code lifespan associated with OAuthEntity.
sys_mod_count number Number of times that the associated OAuthEntity record has been modified.
sys_package object The system system package.
 link string Link to system package
 value string Value to system package
client_uuid string uuid of client.
type string The type of OAuthEntity.
public_client boolean Indicates if the OAuthEntity is public_client or not.
oauth_api_script string The oauth api script associated with the OAuthEntity.
sys_tags string The sys tags associated with the OAuthEntity.
logo_url string URL of the logo.
sys_class_name string Represents the table name.
sys_updated_by string User that last updated the associated OAuthEntity information.
revoke_token_url string The revoke token url.
redirect_url string The redirect URLs authorization server redirect to. They must be absolute URLs and they are comma separated.
message_signature_lifespan number The lifespan of message signature.
access string Type of access
sys_updated_on number Data and time the associated OAuthEntity information was updated.
sys_created_by string User that originally created the associated User record.
salt string The salt value.
use_mutual_auth boolean Flag that indicates the OAuthEntity uses mutual auth.
name string Name of the OAuthEntity.
refresh_token_url string Refresh token url.
mobile_client boolean .
token_url string The url of the token.
comments string Comments on the associated OAuthEntity.
access_token_lifespan number Time in seconds the Access Token will be valid.
certificate_url string url of the certificate.
send_client_credentials_as string The way the client credentails are sent like i request parameter or header.
code_challenge_method string The method defined code challenge associated with the OAuthEntity.
sys_update_name string Concatenation of table name with id of the OAuthEntity.
user string .
protocol_name string Name of the protocol.
sys_created_on number Data and time the associated OAuthEntity was originally created.
sys_scope object The system scope.
 link string Link to system scope
 value string Value to system scope
id_token_lifespan number Value of the id token lifespan.
active boolean Flag that indicates whether the OAuthEntity is active within the system.
skip_authorize boolean Flag that indicates whether authorization can be skipped.
refresh_token_lifespan number Time in seconds the Refresh Token will be valid.
sys_policy string The system policy.
ATTRIBUTE TYPE REFERS TO DESCRIPTION
sys_scope object Application scope that owns this authentication profile.
 link string Link to system scope
 value string Value to system scope
name string The name of the authentication profile.
sys_mod_count number Number of times this record has been modified.
sys_class_name string The class name of the authentication profile (e.g. sys_auth_profile_basic, sys_auth_profile_oauth2).
sys_package object The application package this authentication profile belongs to.
 link string Link to system package
 value string Value to system package
sys_update_name string Unique update name used to identify the record across instances.
sys_policy string Security policy applied to this authentication profile record.
sys_id string Unique system identifier for the record.
sys_created_on number Timestamp when the record was created.
sys_updated_on number Timestamp when the record was last updated.
sys_created_by string Username of the user who created the record.
sys_updated_by string Username of the user who last updated the record.
sys_tags string Tags associated with the record.
sys_name string Display name of the record, typically matches the name field.
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
active boolean Indicates whether this plugin is active.
source string Unique source ID of the plugin.
license_category string License category of the plugin.
sys_class_name string Table name the record belongs to.
sys_mod_count number Number of times this record has been modified.
sys_updated_by string Username of the user who last updated this record.
batch_install_plan string Batch install plan of the plugin.
package_json string Package JSON of the plugin.
trackable boolean Indicates whether the plugin is trackable.
licensable boolean Indicates whether the plugin requires a license.
parent string Source ID of the parent plugin this plugin depends on.
version string Version of the plugin.
sys_created_on number Timestamp of when this record was created.
install_date number Timestamp of when the plugin was installed.
sys_created_by string Username of the user who created this record.
ide_created string Indicates whether the plugin was created in the IDE.
name string Display name of the plugin.
license_model string License model of the plugin.
sys_updated_on number Timestamp of the last update to this record.
sys_tags string Tags associated with the record.
sys_id string Unique identifier for the plugin record.
enforce_license string License enforcement level of the plugin.
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
sys_package object The application package this processor belongs to.
 value string Value to system package
 link string Link to system package
sys_update_name string Unique update name used to identify the record across instances.
active boolean Indicates whether this processor is active.
sys_created_on number Timestamp of when this record was created.
name string Name of the processor.
type string The type of processor (e.g. java, script).
path_endpoint string Specific endpoint path for this processor.
sys_tags string Tags associated with the record.
sys_policy string Security policy applied to this processor record.
description string Description of the processor.
require_csrf boolean Indicates whether CSRF token validation is required for requests to this processor.
sys_mod_count number Number of times this record has been modified.
sys_updated_by string Username of the user who last updated this record.
sys_created_by string Username of the user who created this record.
class_name string Java class name for the processor if type is java.
path string URL path pattern that triggers this processor.
parameters string Parameters passed to this processor.
roles string Comma-separated list of roles required to access this processor. An empty string means the processor is publicly accessible without any role restriction.
sys_updated_on number Timestamp of the last update to this record.
sys_scope object Application scope that owns this processor.
 link string Link to system scope
 value string Value to system scope
sys_id string Unique identifier for the processor record.
sys_name string Name of the processor.
xframe_sameorigin boolean Indicates whether the X-Frame-Options header is set to SAMEORIGIN for this processor's responses.
interactive boolean Indicates whether this processor is interactive (runs in the browser session context).
params_endpoint string Endpoint for parameter handling.
script string Script executed by this processor if type is script.
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
sys_policy string Indicates the policy level of the record. A value of protected suggests that certain rules are in place to safeguard this record from unauthorized access or modification.
active boolean Indicates whether the record is currently active. If set to true, it means the public access is valid and currently in effect.
sys_updated_on number The timestamp of when the record was last updated.
sys_class_name string The name of the system class for this record, which indicates that it belongs to the sys_public table.
sys_package object This element contains information about the package associated with this record.
 link string A URL that provides an API endpoint to access the package details.
 value string The unique identifier of the package
sys_updated_by string The username of the individual who last updated the record.
page string Refers to the specific page or context where this public access applies.
sys_created_by string The username of the individual who created the record.
sys_mod_count number This represents the modification count for the record. It increments each time the record is updated. A value of 0 indicates that the record has not been modified since it was created.
sys_id string A unique identifier for the record in the sys_public table.
sys_update_name string This is a name that identifies the record during updates. It often combines the table name with the record sys_id.
sys_name string The name of the public record. This value represents the record designation and can be used for display purposes.
sys_scope object This element indicates the scope of the record.
 link string A URL providing an API endpoint to access the scope details.
 value string The unique identifier of the scope
sys_tags string This field is used for tagging records. It can hold values that help categorize or identify records.
sys_created_on number The timestamp of when the record was created.
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
type object The type of object the ACL applies to (e.g. record, field).
active boolean Indicates whether this ACL rule is currently active.
sys_mod_count number Number of times this record has been modified.
controlled_by_refs string References to controlling ACL entries.
sys_class_name string The class name of this ACL record.
applies_to string Specifies which records this ACL applies to.
decision_type string The decision type of the ACL rule (e.g. allow, deny).
local_or_existing string Indicates whether the ACL is local or inherited from an existing rule.
script string Script that determines whether the ACL rule applies.
advanced boolean Indicates whether the ACL uses an advanced script condition.
description string Description of the ACL rule.
sys_scope object Application scope that owns this ACL rule.
 link string Link to system scope
 value string Value to system scope
sys_package object The application package this ACL rule belongs to.
 value string Value to system package
 link string Link to system package
sys_update_name string Unique update name used to identify the record across instances.
sys_policy string Security policy applied to this ACL record.
sys_updated_on number Timestamp when the record was last updated.
name string The name of the ACL rule.
operation object The operation controlled by this ACL (e.g. read, write, delete).
condition string Condition expression that must evaluate to true for the ACL to apply.
sys_id string Unique system identifier for the record.
sys_created_on number Timestamp when the record was created.
sys_name string Display name of the record, typically matches the name field.
admin_overrides boolean Indicates whether administrators can override this ACL rule.
sys_created_by string Username of the user who created the record.
sys_updated_by string Username of the user who last updated the record.
sys_tags string Tags associated with the record.
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
notification string Indicates whether the User should receive notifications. Valid values : Disabled, Enabled
sys_domain_path string User record domain path.
sys_updated_by string User that last updated the associated User information.
enable_multifactor_authn boolean Flag that indicates whether multifactor authorization is required for the User to log in to the servicportal.
schedule object ID of the record that describes the work schedule for the associated User.
 link string Link to fetch the cmn_schedule resource
 value string Id of the cmn_schedule resource
source string Source of the user
sys_created_by string User that originally created the associated User record.
locked_out boolean Flag that indicates if the User is locked-out.
last_login_time number The time at which the user last logged in.
last_position_update string Date and time the last position was updated.
ldap_server object Reference to LDAP Server table
 value string Id of the ldap_server resource
 link string Link to fetch the ldap_server resource
name string Name of the user.
sys_created_on number Data and time the associated User was originally created.
sys_updated_on number Data and time the associated User information was updated.
user_name string User Name of the user.
default_perspective object The default perspective of the user
 link string Link to fetch the default_perspective resource
 value string ID of the default_perspective resource
email string Email of the user.
internal_integration_user boolean If set to true can bypass WS-Security authentication while using SOAP interface
hashed_user_id string SHA-256 one-way hash of the sys_user_id.
sys_mod_count number Number of times that the associated User record has been modified
web_service_access_only boolean Flag that indicates whether the User can only access services through the web.
active boolean Flag that indicates whether the User is active within the system
calendar_integration string Calendar application that the User uses. Ex: Outlook.
failed_attempts number Failed login attempts for the user
geolocation_tracked boolean Flag that indicates whether the contact location is obtained through geotracking.
sys_id string Represents the resource id of the user
password_needs_reset boolean Does the users password need resetting
sys_domain object ServiceNow instance domain of the associated User record.
 link string Link to fetch the sys_domain resource
 value string Id of the sys_domain resource
time_sheet_policy string Time sheet policy for the associated contact
vip boolean Flag that indicates whether the associated User has VIP status.
ATTRIBUTE TYPE REFERS TO DESCRIPTION
inh_map string Inheritance Map
role object Role assigned to the user
 link string Link to role
 value string Value to role
state string State of the role assignment
sys_updated_on number Data and time the associated User information was updated.
granted_by object User or role that granted this role to the user
 link string Link to User or role
 value string Value to User or role
inh_count number Inherited count if the role is inherited
inherited boolean Indicates if the role is inherited
included_in_role object Role in which this role is included
 link string Link to user has role
 value string Value to user has role
included_in_role_instance object Role instance in which this role is included
 link string Link to role instance
 value string Value to role instance
sys_created_by string User who created the record
sys_created_on number Data and time the associated User was originally created.
sys_updated_by string User who last updated the record
user object User to whom the role is assigned
 value string Value to user
 link string Link to user
sys_id string Unique system identifier for the record
sys_mod_count number Number of times the record was modified
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
includes_roles list<string> Roles included within this user role
sys_created_on number Data and time the associated User was originally created.
sys_scope object Scope associated with the user role.
 link string Link to system scope
 value string Value to system scope
sys_mod_count number Number of times the record was modified
sys_policy string Policy associated with the user role
can_delegate boolean Indicates if users with this role can delegate tasks
sys_updated_by string User who last updated the record
assignable_by string Roles that can assign this user role
sys_updated_on number Data and time the associated User information was updated.
sys_name string Name of the record
sys_created_by string User who created the record
grantable boolean Indicates if the user role can be granted to other users
elevated_privilege boolean Indicates if the user role has elevated privileges
sys_package object Package associated with the record
 link string Link to system package
 value string Value to system package
description string Description or details of the user role
suffix string Suffix or postfix for the user role
sys_class_name string System class name of the record
scoped_admin boolean Indicates if the user role has scoped administration privileges
sys_id string Unique system identifier for the record
sys_update_name string User who last updated the record
name string Name or label of the user role
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
namespace string Namespace prefix used in the base URI for this REST service.
sys_package object The application package this REST service definition belongs to.
 link string Link to system package
 value string Value to system package
sys_policy string Security policy applied to this REST service definition record.
consumes_customized boolean Indicates whether the consumed content types have been customized from defaults.
produces_customized boolean Indicates whether the produced content types have been customized from defaults.
sys_updated_on number Timestamp of the last update to this record.
name string Name of the scripted REST service definition.
default_version string The default active version for this versioned REST service.
produces string Comma-separated list of content types this service can return.
sys_scope object Application scope that owns this REST service definition.
 link string Link to system scope
 value string Value to system scope
sys_update_name string Unique update name used to identify the record across instances.
sys_id string Unique identifier for the scripted REST service definition record.
is_versioned boolean Indicates whether this REST service definition supports versioning.
short_description string Brief description of the scripted REST service definition.
consumes string Comma-separated list of content types this service accepts as input.
sys_tags string Tags associated with the record.
sys_name string Name of the scripted REST service definition.
active boolean Indicates whether this REST service definition is active and its operations can be invoked.
enforce_acl string Comma-separated sys_ids of ACL records enforced on this service definition. Empty string means no ACLs are enforced.
sys_created_on number Timestamp of when this record was created.
sys_updated_by string Username of the user who last updated this record.
doc_link string URL to external documentation for this REST service.
base_uri string Base URI path for all operations in this REST service definition.
service_id string Unique identifier string for the REST service used in the URI namespace.
sys_mod_count number Number of times this record has been modified.
sys_created_by string Username of the user who created this record.
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
operation_script string Script executed when this REST operation is invoked.
consumes_customized boolean Indicates whether the consumed content types have been customized from defaults.
produces_customized boolean Indicates whether the produced content types have been customized from defaults.
operation_uri string Full URI path for this operation.
sys_id string Unique identifier for the scripted REST operation record.
sys_mod_count number Number of times this record has been modified.
sys_created_on number Timestamp of when this record was created.
consumes string Comma-separated list of content types this operation accepts as input.
sys_policy string Security policy applied to this REST operation record.
default_operation_uri string Default URI path if no versioned URI is specified.
sys_updated_by string Username of the user who last updated this record.
requires_snc_internal_role boolean If true, only users with an internal ServiceNow role can invoke this operation.
enforce_acl string Comma-separated sys_ids of ACL records enforced on this operation. Empty string means no ACLs are enforced.
sys_updated_on number Timestamp of the last update to this record.
requires_acl_authorization boolean If true, ACL rules are evaluated for each request to this operation.
name string Name of the scripted REST operation.
sys_name string Name of the scripted REST operation.
sys_created_by string Username of the user who created this record.
short_description string Brief description of the scripted REST operation.
request_example string Example request body for this operation.
sys_update_name string Unique update name used to identify the record across instances.
web_service_version string Version of the REST service this operation belongs to.
http_method string HTTP method for this operation (e.g. GET, POST, PUT, DELETE).
relative_path string Relative path of this operation within the parent REST service.
sys_scope object Application scope that owns this REST operation.
 link string Link to system scope
 value string Value to system scope
sys_package object The application package this REST operation belongs to.
 link string Link to system package
 value string Value to system package
produces string Comma-separated list of content types this operation can return.
sys_tags string Tags associated with the record.
active boolean Indicates whether this REST operation is active and can be invoked.
requires_authentication boolean If true, callers must authenticate before invoking this operation. A value of false means the endpoint is publicly accessible without credentials.
web_service_definition object Reference to the parent scripted REST service definition that owns this operation.
 link string URL to access the parent service definition record via the REST API.
 value string sys_id of the parent scripted REST service definition.
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
choices string Comma-separated values for a choice list.
is_private string If this property is true, ServiceNow will exclude this property from being imported via update sets. Keeping system properties private prevents settings in one instance from overwriting values in another instance. For example, you may not want a system property in a development instance to use the same value as a production instance.
write_roles string Defines the roles that have write access to this property.
read_roles string Defines the roles that have read access to this property.
name string The property name.
value string The property value.
number_value number The value as a number representation. This value will be populated if the value is of a numerical type. It can be utilized for writing NGL rules that numerical expression evaluation (i.e. greater than).
type string The data type of the property value.