PrivGroup

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getPrivGroup

post

Retrieve privilege group

Authorizations
Body
PrivGroupGroupintegerRequired
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PrivGroupGroup": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PrivGroup": {
    "AssignablebyMemberUser": 1,
    "Description": "text",
    "Group": 1,
    "SecurityAmount": [
      {
        "EntryId": 1,
        "SecurityAmount": 1
      }
    ]
  }
}

getPrivGroupSelectFields

post

Returns the privilege groups with select fields

Authorizations
Body
PrivGroupGroupintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PrivGroupGroup": 1,
  "SelectableFields": {
    "IncludeAllPrivGroupFields": true,
    "PrivGroupFields": {
      "AssignablebyMemberUser": true,
      "Description": true,
      "Group": true,
      "SecurityAmount": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PrivGroup": {
    "AssignablebyMemberUser": 1,
    "Description": "text",
    "Group": 1,
    "SecurityAmount": [
      {
        "EntryId": 1,
        "SecurityAmount": 1
      }
    ]
  }
}

getPrivGroupPagedList

post

Returns paged list of privilege groups

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getPrivGroupPagedList
POST /nexum/627/2022.01/parameter/getPrivGroupPagedList 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.

{
  "PrivGroup": [
    {
      "AssignablebyMemberUser": 1,
      "Description": "text",
      "Group": 1,
      "SecurityAmount": [
        {
          "EntryId": 1,
          "SecurityAmount": 1
        }
      ]
    }
  ],
  "Token": "text"
}

getPrivGroupListSelectFields

post

Returns the list of privilege groups with select fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllPrivGroupFields": true,
    "PrivGroupFields": {
      "AssignablebyMemberUser": true,
      "Description": true,
      "Group": true,
      "SecurityAmount": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PrivGroupList": {
    "hasReachedMaximumListSize": true,
    "PrivGroup": [
      {
        "AssignablebyMemberUser": 1,
        "Description": "text",
        "Group": 1,
        "SecurityAmount": [
          {
            "EntryId": 1,
            "SecurityAmount": 1
          }
        ]
      }
    ]
  }
}

searchPrivGroupSelectFields

post

Retrieve a list of select fields for privilege groups

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllPrivGroupFields": true,
    "PrivGroupFields": {
      "AssignablebyMemberUser": true,
      "Description": true,
      "Group": true,
      "SecurityAmount": [
        1
      ]
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PrivGroupList": {
    "hasReachedMaximumListSize": true,
    "PrivGroup": [
      {
        "AssignablebyMemberUser": 1,
        "Description": "text",
        "Group": 1,
        "SecurityAmount": [
          {
            "EntryId": 1,
            "SecurityAmount": 1
          }
        ]
      }
    ]
  }
}

getPrivGroupPagedListSelectFields

post

Returns paged list of privilege groups with select fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllPrivGroupFields": true,
    "PrivGroupFields": {
      "AssignablebyMemberUser": true,
      "Description": true,
      "Group": true,
      "SecurityAmount": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PrivGroup": [
    {
      "AssignablebyMemberUser": 1,
      "Description": "text",
      "Group": 1,
      "SecurityAmount": [
        {
          "EntryId": 1,
          "SecurityAmount": 1
        }
      ]
    }
  ],
  "Token": "text"
}

searchPrivGroupPagedSelectFields

post

Retrieve a paged list of select fields for privilege groups

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllPrivGroupFields": true,
    "PrivGroupFields": {
      "AssignablebyMemberUser": true,
      "Description": true,
      "Group": true,
      "SecurityAmount": [
        1
      ]
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "PrivGroup": [
    {
      "AssignablebyMemberUser": 1,
      "Description": "text",
      "Group": 1,
      "SecurityAmount": [
        {
          "EntryId": 1,
          "SecurityAmount": 1
        }
      ]
    }
  ],
  "Token": "text"
}

updatePrivGroupByID

post

Update privileged groups by ID

Authorizations
Body
PrivGroupGroupintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PrivGroupGroup": 1,
  "PrivGroupUpdatableFields": {
    "AssignablebyMemberUser": 1,
    "Description": "text",
    "SecurityAmount": [
      {
        "EntryId": 1,
        "SecurityAmount": 1
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?