ordercloud-javascript-sdk
    Preparing search index...

    Class Users

    Index
    As Create Delete Get GetAccessToken List ListAcrossBuyers Move Patch RevokeUserTokens Save UnlockUserAccount

    • Returns this

      enables impersonation by calling the subsequent method with the stored impersonation token

      Users.As().List() // lists Users using the impersonated users' token

    • Create a user Check out the docs for more info

      Type Parameters

      • TUser extends User<any>

      Parameters

      • buyerID: string

        ID of the buyer.

      • user: User

        Required fields: Username, FirstName, LastName, Email, Active

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<RequiredDeep<TUser>>

    • Delete a user Check out the docs for more info

      Parameters

      • buyerID: string

        ID of the buyer.

      • userID: string

        ID of the user.

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<void>

    • Retrieve a user Check out the docs for more info

      Type Parameters

      • TUser extends User<any>

      Parameters

      • buyerID: string

        ID of the buyer.

      • userID: string

        ID of the user.

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<RequiredDeep<TUser>>

    • List users Check out the docs for more info

      Type Parameters

      • TUser extends User<any>

      Parameters

      • buyerID: string

        ID of the buyer.

      • listOptions: {
            filters?: Filters;
            page?: number;
            pageSize?: number;
            search?: string;
            searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[];
            sortBy?: (
                | "ID"
                | "LastName"
                | "FirstName"
                | "Username"
                | "Email"
                | "DateCreated"
                | "!ID"
                | "!DateCreated"
                | "!FirstName"
                | "!LastName"
                | "LastActive"
                | "PasswordLastSetDate"
                | "!Username"
                | "!Email"
                | "!LastActive"
                | "!PasswordLastSetDate"
            )[];
            userGroupID?: string;
        } = {}
        • Optionalfilters?: Filters

          An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

        • Optionalpage?: number

          Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

        • OptionalpageSize?: number

          Number of results to return per page.

        • Optionalsearch?: string

          Word or phrase to search for.

        • OptionalsearchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]

          Comma-delimited list of fields to search on.

        • OptionalsortBy?: (
              | "ID"
              | "LastName"
              | "FirstName"
              | "Username"
              | "Email"
              | "DateCreated"
              | "!ID"
              | "!DateCreated"
              | "!FirstName"
              | "!LastName"
              | "LastActive"
              | "PasswordLastSetDate"
              | "!Username"
              | "!Email"
              | "!LastActive"
              | "!PasswordLastSetDate"
          )[]

          Comma-delimited list of fields to sort by.

        • OptionaluserGroupID?: string

          ID of the user group.

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<RequiredObjectDeep<ListPage<TUser>>>

    • List user across buyers Check out the docs for more info

      Type Parameters

      • TUser extends User<any>

      Parameters

      • listOptions: {
            filters?: Filters;
            page?: number;
            pageSize?: number;
            search?: string;
            searchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[];
            sortBy?: (
                | "ID"
                | "LastName"
                | "FirstName"
                | "Username"
                | "Email"
                | "DateCreated"
                | "!ID"
                | "!DateCreated"
                | "!FirstName"
                | "!LastName"
                | "LastActive"
                | "PasswordLastSetDate"
                | "!Username"
                | "!Email"
                | "!LastActive"
                | "!PasswordLastSetDate"
            )[];
        } = {}
        • Optionalfilters?: Filters

          An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

        • Optionalpage?: number

          Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

        • OptionalpageSize?: number

          Number of results to return per page.

        • Optionalsearch?: string

          Word or phrase to search for.

        • OptionalsearchOn?: ("ID" | "LastName" | "FirstName" | "Username" | "Email")[]

          Comma-delimited list of fields to search on.

        • OptionalsortBy?: (
              | "ID"
              | "LastName"
              | "FirstName"
              | "Username"
              | "Email"
              | "DateCreated"
              | "!ID"
              | "!DateCreated"
              | "!FirstName"
              | "!LastName"
              | "LastActive"
              | "PasswordLastSetDate"
              | "!Username"
              | "!Email"
              | "!LastActive"
              | "!PasswordLastSetDate"
          )[]

          Comma-delimited list of fields to sort by.

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<RequiredObjectDeep<ListPage<TUser>>>

    • Move a user to a different buyer Check out the docs for more info

      Type Parameters

      • TUser extends User<any>

      Parameters

      • buyerID: string

        ID of the buyer.

      • userID: string

        ID of the user.

      • newBuyerID: string

        ID of the new buyer.

      • listOptions: { orders?: UserOrderMoveOption } = {}
        • Optionalorders?: UserOrderMoveOption

          Orders of the user. Possible values: None, Unsubmitted, All.

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<RequiredDeep<TUser>>

    • Partially update a user Check out the docs for more info

      Type Parameters

      • TUser extends User<any>

      Parameters

      • buyerID: string

        ID of the buyer.

      • userID: string

        ID of the user.

      • user: PartialDeep<User>
      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<RequiredDeep<TUser>>

    • Revoke a user tokens Revokes all security tokens of specified buyer user. Check out the docs for more info

      Parameters

      • buyerID: string

        ID of the buyer.

      • userID: string

        ID of the user.

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<void>

    • Create or update a user If an object with the same ID already exists, it will be overwritten. Check out the docs for more info

      Type Parameters

      • TUser extends User<any>

      Parameters

      • buyerID: string

        ID of the buyer.

      • userID: string

        ID of the user.

      • user: User

        Required fields: Username, FirstName, LastName, Email, Active

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<RequiredDeep<TUser>>

    • Unlock a user account Check out the docs for more info

      Parameters

      • buyerID: string

        ID of the buyer.

      • userID: string

        ID of the user.

      • requestOptions: RequestOptions = {}
        • OptionalaccessToken?: string

          Alternative token to the one stored in the sdk instance (useful for impersonation).

        • OptionalrequestType?: string

          Identify the type of request. Useful for error logs.

        • Optionalsignal?: AbortSignal

          AbortSignal that can be used to cancel the request.

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods