Resource URL: /platform/<<version=1>>/auth/id

    Overview: This resource contains the currently authenticated security token.

     Methods: GET

********************************************************************************

Method GET: Retrieve the current security token.

       URL: GET /platform/<<version=1>>/auth/id

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "ntoken": {
      "type": "object", 
      "description": "Specifies properties for a security token for the currently authenticated user.", 
      "properties": {
        "on_disk_user_id": {
          "type": [
            {
              "type": "object", 
              "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
              "properties": {
                "type": {
                  "enum": [
                    "user", 
                    "group", 
                    "wellknown"
                  ], 
                  "type": "string", 
                  "description": "Specifies the type of persona, which must be combined with a name."
                }, 
                "id": {
                  "type": "string", 
                  "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                }, 
                "name": {
                  "type": "string", 
                  "description": "Specifies the persona name, which must be combined with a type."
                }
              }
            }
          ], 
          "description": "Specifies the user ID that is stored on disk for the authenticated user."
        }, 
        "uid": {
          "type": [
            {
              "type": "object", 
              "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
              "properties": {
                "type": {
                  "enum": [
                    "user", 
                    "group", 
                    "wellknown"
                  ], 
                  "type": "string", 
                  "description": "Specifies the type of persona, which must be combined with a name."
                }, 
                "id": {
                  "type": "string", 
                  "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                }, 
                "name": {
                  "type": "string", 
                  "description": "Specifies the persona name, which must be combined with a type."
                }
              }
            }, 
            {
              "type": "null"
            }
          ], 
          "description": "Specifies the currently authenticated user ID."
        }, 
        "ifs_restricted": {
          "type": "boolean", 
          "description": "Indicates if this user has restricted access to the /ifs file system."
        }, 
        "user_sid": {
          "type": [
            {
              "type": "object", 
              "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
              "properties": {
                "type": {
                  "enum": [
                    "user", 
                    "group", 
                    "wellknown"
                  ], 
                  "type": "string", 
                  "description": "Specifies the type of persona, which must be combined with a name."
                }, 
                "id": {
                  "type": "string", 
                  "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                }, 
                "name": {
                  "type": "string", 
                  "description": "Specifies the persona name, which must be combined with a type."
                }
              }
            }, 
            {
              "type": "null"
            }
          ], 
          "description": "Specifies the currently authenticated security ID for the user."
        }, 
        "on_disk_group_id": {
          "type": [
            {
              "type": "object", 
              "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
              "properties": {
                "type": {
                  "enum": [
                    "user", 
                    "group", 
                    "wellknown"
                  ], 
                  "type": "string", 
                  "description": "Specifies the type of persona, which must be combined with a name."
                }, 
                "id": {
                  "type": "string", 
                  "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                }, 
                "name": {
                  "type": "string", 
                  "description": "Specifies the persona name, which must be combined with a type."
                }
              }
            }
          ], 
          "description": "Specifies the group ID that is stored on disk for the authenticated user."
        }, 
        "remote_address": {
          "type": [
            "string", 
            "null"
          ], 
          "description": "Specifies the IP address of the client requesting information."
        }, 
        "protocol": {
          "type": [
            "integer", 
            "null"
          ], 
          "description": "Specifies the protocol that is responsible for the creation of the token. The integer values for each protcol are as follows: NFS (1), SMB (2), NLM (3), FTP (4), HTTP (5), ISCSI (7), SMB2 (8), NFS4 (9), OneFS API (10), HDFS (15), console (16), and SSH (17)."
        }, 
        "zid": {
          "type": [
            "integer", 
            "null"
          ], 
          "description": "Specifies the zone ID of the access zone that is serving the request."
        }, 
        "gid": {
          "type": [
            {
              "type": "object", 
              "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
              "properties": {
                "type": {
                  "enum": [
                    "user", 
                    "group", 
                    "wellknown"
                  ], 
                  "type": "string", 
                  "description": "Specifies the type of persona, which must be combined with a name."
                }, 
                "id": {
                  "type": "string", 
                  "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                }, 
                "name": {
                  "type": "string", 
                  "description": "Specifies the persona name, which must be combined with a type."
                }
              }
            }, 
            {
              "type": "null"
            }
          ], 
          "description": "Specifies properties for the currently authenticated primary group ID for the user."
        }, 
        "additional_id": {
          "items": {
            "type": "object", 
            "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
            "properties": {
              "type": {
                "enum": [
                  "user", 
                  "group", 
                  "wellknown"
                ], 
                "type": "string", 
                "description": "Specifies the type of persona, which must be combined with a name."
              }, 
              "id": {
                "type": "string", 
                "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
              }, 
              "name": {
                "type": "string", 
                "description": "Specifies the persona name, which must be combined with a type."
              }
            }
          }, 
          "type": "array", 
          "description": "Specifies additional UIDs, GIDs, and SIDs."
        }, 
        "local_address": {
          "type": [
            "string", 
            "null"
          ], 
          "description": "Specifies the IP address of the node that is serving the request."
        }, 
        "privilege": {
          "items": {
            "type": "object", 
            "description": "Specifies the system-defined privilege that may be granted to users.", 
            "properties": {
              "read_only": {
                "type": "boolean", 
                "description": "True, if the privilege is read-only."
              }, 
              "id": {
                "required": true, 
                "type": "string", 
                "description": "Specifies the ID of the privilege."
              }, 
              "name": {
                "type": "string", 
                "description": "Specifies the name of the privilege."
              }
            }
          }, 
          "type": "array", 
          "description": "Specifies the privileges granted to the currently authenticated user."
        }, 
        "group_sid": {
          "type": [
            {
              "type": "object", 
              "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
              "properties": {
                "type": {
                  "enum": [
                    "user", 
                    "group", 
                    "wellknown"
                  ], 
                  "type": "string", 
                  "description": "Specifies the type of persona, which must be combined with a name."
                }, 
                "id": {
                  "type": "string", 
                  "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                }, 
                "name": {
                  "type": "string", 
                  "description": "Specifies the persona name, which must be combined with a type."
                }
              }
            }, 
            {
              "type": "null"
            }
          ], 
          "description": "Specifies properties for the currently authenticated primary group security ID for the user."
        }, 
        "zone_id": {
          "type": [
            "string", 
            "null"
          ], 
          "description": "Specifies the name of the access zone that is serving the request."
        }
      }
    }
  }
}
