Get a searchbase

GET 
/api/web/v1/searchbases/:searchbaseid

Get the specified searchbase. Caller requires the DIRECTORIES:VIEW permission.

Request

Path Parameters

searchbaseid stringrequired

The UUID of the searchbase to be returned.

Responses

200

Successful

application/json

Schema

Schema

directoryId string

The UUID of the Directory the seachbase belongs to.

emptySearchBase boolean

Whether or not an empty searchbase is empty?

id string

The UUID of the searchbase.

node string

The searchbase node.

subsearchbasesIncluded boolean

Whether or not a sub-tree is included?

Example (from schema)

{
  "directoryId": "6781549d-433c-44ea-a42f-4705c26f3245",
  "emptySearchBase": true,
  "id": "6781549d-433c-44ea-a42f-4705c26f3245",
  "node": "DC=Users",
  "subsearchbasesIncluded": true
}

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...