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

    Interface GraphQLApi

    interface GraphQLApi {
        $id: string | number | ExplicitKey<string>;
        $override?: Record<string, string | number | boolean>;
        active?: boolean;
        applicationNamespace?: string;
        contextualAclMaxDepth?: number;
        enforceAcl?: (string | Acl<(keyof Tables), AclType>)[];
        name: string;
        namespace: string;
        protectionPolicy?: "read" | "protected";
        requiresAclAuthorization?: boolean;
        requiresAuthentication?: boolean;
        requiresSncInternalRole?: boolean;
        resolvers?: GraphQLResolver[];
        schema: string;
        typeResolvers?: GraphQLTypeResolver[];
    }
    Index

    Properties

    $id $override? active? applicationNamespace? contextualAclMaxDepth? enforceAcl? name namespace protectionPolicy? requiresAclAuthorization? requiresAuthentication? requiresSncInternalRole? resolvers? schema typeResolvers?

    Properties

    $id: string | number | ExplicitKey<string>
    $override?: Record<string, string | number | boolean>

    Set properties not directly supported by this API.

    active?: boolean

    Indicates whether the API can serve requests. Defaults to true.

    applicationNamespace?: string

    The top-level namespace in the query envelope, as in { xSncMyApp { myApi { ... } } }. Derived from the application scope; only honored in global scope, where it falls back to now. Must be a valid GraphQL name, 40 characters or fewer.

    contextualAclMaxDepth?: number

    The maximum path depth at which field-level path ACLs are enforced. Depth counts every segment of the ACL path, including the two envelope segments, so /xSncMyApp/myApi/items/cost is depth 4. Defaults to 4, which covers top-level and second-level fields.

    enforceAcl?: (string | Acl<(keyof Tables), AclType>)[]

    Schema-gate ACLs (sys_security_acl) that control access to the whole API. Accepts ACL sys_ids or Acl references. Field-level path ACLs are standalone Acl({ type: 'graphql' }) records, not set here.

    name: string

    The name of the GraphQL API.

    namespace: string

    The API namespace used in the query envelope and in runtime ACL paths (for example myApi in { xSncMyApp { myApi { ... } } }). Must be a valid GraphQL name, unique among the APIs in its application namespace.

    protectionPolicy?: "read" | "protected"

    Controls edit/view access for other developers after the application is installed.

    • read: Others can see the script logic but not change it.
    • protected: Others cannot change this record.
    • Omit to allow other developers to customize this record.
    requiresAclAuthorization?: boolean

    If true, the schema-gate ACLs in enforceAcl are enforced. Defaults to true.

    requiresAuthentication?: boolean

    If true, callers must be authenticated. Defaults to true.

    requiresSncInternalRole?: boolean

    If true, callers must hold the snc_internal role. Defaults to true.

    resolvers?: GraphQLResolver[]

    Resolvers that fetch field data, each bound to one or more schema paths.

    schema: string

    The schema definition language (SDL) for the API. Inline, or Now.include('./schema.graphql'). The platform compiles it on insert.

    typeResolvers?: GraphQLTypeResolver[]

    Type resolvers for the unions and interfaces in the schema.

    Settings

    Member Visibility

    On This Page

    Properties