IRPCWebAccessAdmin.QueryADSIObjects
Administration API / specialized internal: not for applications admin session idempotent
Lists the child objects of an IIS (ADSI) path on the server computer, for example its web sites.
| Service | Web access administration MFiles.IRPCWebAccessAdmin |
|---|---|
| gRPC method | /MFiles.IRPCWebAccessAdmin/QueryADSIObjects |
| HTTP (mf-http-grpc) | POST /grpc/v1/query-adsiobjects |
| Request | QueryADSIObjectsRequest |
| Response | QueryADSIObjectsResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
For M-Files components only. M-Files Admin uses it to list the IIS web sites. Applications should not call it.
- Requires the system administrator server role (server right
edit_web_access_settings). - Checks the IIS and ASP.NET prerequisites first and fails if they are missing.
Request: QueryADSIObjectsRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
key | string | The ADSI path to enumerate, for example IIS://localhost/w3svc for the web sites. |
schema_class | string | Return only children of this schema class; unset returns all children. |
Response: QueryADSIObjectsResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
objects[] | repeated ADSIObject | ADSI objects. |
objects[].name | string | The name of the object. |
objects[].display_name | string | The display name of the object. |
objects[].schema_class | string | The name of the object's schema class. |
objects[].guid | string | The GUID of the object as stored in the underlying directory store. |
objects[].path | string | The object's ADsPath that uniquely identifies this object from all others. |
objects[].parent_path | string | The ADsPath string for the parent of the object. |