ldap-api/swagger-api-spec.json at master · CU-CloudCollab/ldap-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
{
    "swagger": "2.0",
    "info": {
        "title": "Cornell LDAP REST API",
        "description": "Access to Cornell LDAP via REST",
        "version": "1.0.0"
    },
    "host": "ldap-api.training.cucloud.net",
    "schemes": [
        "https",
        "http"
    ],
    "basePath": "/v1",
    "produces": [
        "application/json"
    ],
    "paths": {
        "/person": {
            "get": {
                "summary": "LDAP person",
                "description": "Example description\n",
                "parameters": [
                    {
                        "name": "netid",
                        "in": "query",
                        "description": "Cornell netID",
                        "required": true,
                        "type": "string"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "The set of LDAP properties for this person associated with this netid",
                        "schema": {
                            "type": "array",
                            "items": {
                                "$ref": "#/definitions/Person"
                            }
                        }
                    },
                    "default": {
                        "description": "Unexpected error",
                        "schema": {
                            "$ref": "#/definitions/Error"
                        }
                    }
                }
            }
        }
    },
    "definitions": {
        "Person": {
            "type": "object",
            "properties": {
                "uid": {
                    "type": "string",
                    "description": "Cornell netid"
                },
                "cn": {
                    "type": "string",
                    "description": "LDAP Common Name"
                },
                "displayName": {
                    "type": "string",
                    "description": "Display name"
                },
                "cornelleducampusphone": {
                    "type": "string",
                    "description": "Campus phone number"
                }
            }
        },
        "Error": {
            "type": "object",
            "properties": {
                "code": {
                    "type": "integer",
                    "format": "int32"
                },
                "message": {
                    "type": "string"
                },
                "fields": {
                    "type": "string"
                }
            }
        }
    }
}