Skip to main content

Reset Remote

POST 
/api

Perform a server side reset, currently only the User entity attribute api_key is supported. This operation was added in ftrack version 3.5.18.

Request​

Header Parameters

    Ftrack-Api-Options any
            Api options formatted as key value pairs separated by semicolon. 
            Suported values are:
             - denormalize
             - strict

             denormalize - data is not normalised before sent to client which means there is no need to merge entities client side. 
             Must also have strict option enabled.
             strict - only requested data is loaded and returned to the client

             Examples:

             denormalize=1;strict=1
             denormalize=False;strict=True
             denormalize=false;strict=false
    Ftrack-Api-Key any
            API key used to authenticate. API keys are created from Settings under the page API keys.
    Ftrack-User any
            Username used to authenticate.

Body

array

required

  • Array [

    • action Actionrequired

    Possible values: [reset_remote]

    entity_type ResetRemoteEntityTyperequired

    Possible values: [User, ApiKey]

    entity_key

    object

    nullable

    anyOf

    string

    reset_type Reset Typerequired

    Possible values: [password]

    entity_data

    object

    required

    generate_password Generate Password
    new_password New Password
    old_password Old Password

    metadata

    object

    property name* any

  • ]

Responses​

Successful Response

Loading...