List directory group filters

GET 
/api/web/v1/directories/:id/groupfilters

List all directory group filters for a given directory. Caller requires the DIRECTORIES:VIEW permission.

Request

Path Parameters

id stringrequired

The UUID of the directory whose group filters are to be returned.

Responses

200

Successful

application/json

Schema

Schema

• Array [

directoryId string

The UUID of the Directory the group filter belongs to.

id string

The UUID of the group filter.

name string

The name of the group to filter on.

• ]

Example (from schema)

[
  {
    "directoryId": "6781549d-433c-44ea-a42f-4705c26f3245",
    "id": "6781549d-433c-44ea-a42f-4705c26f3245",
    "name": "Engineering"
  }
]

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...