Functions#

This is the endpoint which is most locked down in the service. Viewing functions is limited to MSS and power users. Modifying functions is limited to sysadmin and those with full administrative access. Also note that when adding a function or role it needs to be added as a child to an existing function since the function graph needs to be connected.

Fetching a function#

To fetch a function you need to know the name or ID of the function

curl -H "Argus-API-Key: my/api/key" https://api.mnemonic.no/useradmin/v2/function/VIEW-INTEGRATIONGUIDE

This returns the function model:

{
  "data": {
    "id": 1,
    "name": "INTEGRATIONGUIDE-READERS",
    "description": "Allows access to read the integration guide",
    "minimumSecurityLevel": "external",
    "flags": [
      "role"
    ],
    ...
  }
}

The endpoints searching and listing functions return the same function datamodel.

Tip

See the Swagger API documentation for details on the returned data model.

Listing a functions children#

To list a functions children you need the name or ID of the parent function

curl -H "Argus-API-Key: my/api/key" https://api.mnemonic.no/useradmin/v2/function/VIEW-INTEGRATIONGUIDE/children

This returns a list of all the children of the function

Listing a functions parents#

To list a functions parents you need the name or ID of the child function

curl -H "Argus-API-Key: my/api/key" https://api.mnemonic.no/useradmin/v2/function/VIEW-INTEGRATIONGUIDE/parents

This returns a list of all the parents of the function

Searching for functions#

Searching for functions can be done using the simple search GET endpoint or the advanced search POST endpoint.

Please read the General integration guide to learn about general concepts for search endpoints.