Security

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getSecurity

post

Retrieve security

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

SecuritySecurityCategoryintegerOptional

SecurityRecordSelectionintegerOptional

Responses

200

Successful operation.

application/json

post

/getSecurity

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getSecurity HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SecuritySecurityCategory": 1,
  "SecurityRecordSelection": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Security": {
    "AttemptRecordCode": 1,
    "Description": "text",
    "EventLogCode": 1,
    "Level": 1,
    "SecurityCategory": 1,
    "RecordSelection": 1
  }
}

getSecuritySelectFields

post

Returns the security with select fields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

SecuritySecurityCategoryintegerOptional

SecurityRecordSelectionintegerOptional

Responses

200

Successful operation.

application/json

post

/getSecuritySelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getSecuritySelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 377

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SecuritySecurityCategory": 1,
  "SecurityRecordSelection": 1,
  "SelectableFields": {
    "IncludeAllSecurityFields": true,
    "SecurityFields": {
      "AttemptRecordCode": true,
      "Description": true,
      "EventLogCode": true,
      "Level": true,
      "RecordSelection": true,
      "SecurityCategory": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Security": {
    "AttemptRecordCode": 1,
    "Description": "text",
    "EventLogCode": 1,
    "Level": 1,
    "SecurityCategory": 1,
    "RecordSelection": 1
  }
}

getSecurityPagedList

post

Returns paged list of security

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getSecurityPagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getSecurityPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Security": [
    {
      "AttemptRecordCode": 1,
      "Description": "text",
      "EventLogCode": 1,
      "Level": 1,
      "SecurityCategory": 1,
      "RecordSelection": 1
    }
  ],
  "Token": "text"
}

getSecurityListSelectFields

post

Returns the list of security with select fields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getSecurityListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getSecurityListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 320

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllSecurityFields": true,
    "SecurityFields": {
      "AttemptRecordCode": true,
      "Description": true,
      "EventLogCode": true,
      "Level": true,
      "RecordSelection": true,
      "SecurityCategory": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "SecurityList": {
    "hasReachedMaximumListSize": true,
    "Security": [
      {
        "AttemptRecordCode": 1,
        "Description": "text",
        "EventLogCode": 1,
        "Level": 1,
        "SecurityCategory": 1,
        "RecordSelection": 1
      }
    ]
  }
}

searchSecuritySelectFields

post

Retrieve a list of select fields for security settings

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/searchSecuritySelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/searchSecuritySelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 352

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllSecurityFields": true,
    "SecurityFields": {
      "AttemptRecordCode": true,
      "Description": true,
      "EventLogCode": true,
      "Level": true,
      "RecordSelection": true,
      "SecurityCategory": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "SecurityList": {
    "hasReachedMaximumListSize": true,
    "Security": [
      {
        "AttemptRecordCode": 1,
        "Description": "text",
        "EventLogCode": 1,
        "Level": 1,
        "SecurityCategory": 1,
        "RecordSelection": 1
      }
    ]
  }
}

getSecurityPagedListSelectFields

post

Returns paged list of security with select fields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getSecurityPagedListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getSecurityPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 414

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllSecurityFields": true,
    "SecurityFields": {
      "AttemptRecordCode": true,
      "Description": true,
      "EventLogCode": true,
      "Level": true,
      "RecordSelection": true,
      "SecurityCategory": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Security": [
    {
      "AttemptRecordCode": 1,
      "Description": "text",
      "EventLogCode": 1,
      "Level": 1,
      "SecurityCategory": 1,
      "RecordSelection": 1
    }
  ],
  "Token": "text"
}

searchSecurityPagedSelectFields

post

Retrieve a paged list of select fields for security settings

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

post

/searchSecurityPagedSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/searchSecurityPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 429

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllSecurityFields": true,
    "SecurityFields": {
      "AttemptRecordCode": true,
      "Description": true,
      "EventLogCode": true,
      "Level": true,
      "RecordSelection": true,
      "SecurityCategory": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "Security": [
    {
      "AttemptRecordCode": 1,
      "Description": "text",
      "EventLogCode": 1,
      "Level": 1,
      "SecurityCategory": 1,
      "RecordSelection": 1
    }
  ],
  "Token": "text"
}

updateSecurityByID

post

Update securities by ID

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

SecuritySecurityCategoryintegerOptional

SecurityRecordSelectionintegerOptional

Responses

200

Successful operation.

application/json

post

/updateSecurityByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/updateSecurityByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 279

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SecuritySecurityCategory": 1,
  "SecurityRecordSelection": 1,
  "SecurityUpdatableFields": {
    "AttemptRecordCode": 1,
    "Description": "text",
    "EventLogCode": 1,
    "Level": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}