{ "opencollection": "1.0.0", "info": { "name": "Equinix API Authentication Users API", "version": "1.2" }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Retrieve current user invitations", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/invitations", "params": [ { "name": "include", "value": "", "type": "query", "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects." }, { "name": "page", "value": "", "type": "query", "description": "Page to return" }, { "name": "per_page", "value": "", "type": "query", "description": "Items returned per page" } ] }, "docs": "Returns all invitations in current user." }, { "info": { "name": "Retrieve the current user", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/user", "params": [ { "name": "include", "value": "", "type": "query", "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects." }, { "name": "exclude", "value": "", "type": "query", "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects." } ] }, "docs": "Returns the user object for the currently logged-in user." }, { "info": { "name": "Update the current user", "type": "http" }, "http": { "method": "PUT", "url": "https://api.equinix.com/user", "params": [ { "name": "include", "value": "", "type": "query", "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects." }, { "name": "exclude", "value": "", "type": "query", "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the currently logged-in user." }, { "info": { "name": "Retrieve all users", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/users", "params": [ { "name": "include", "value": "", "type": "query", "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects." }, { "name": "exclude", "value": "", "type": "query", "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects." }, { "name": "page", "value": "", "type": "query", "description": "Page to return" }, { "name": "per_page", "value": "", "type": "query", "description": "Items returned per page" } ] }, "docs": "Returns a list of users that the are accessible to the current user (all users in the current user’s projects, essentially)." }, { "info": { "name": "Create a user", "type": "http" }, "http": { "method": "POST", "url": "https://api.equinix.com/users", "params": [ { "name": "include", "value": "", "type": "query", "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects." }, { "name": "exclude", "value": "", "type": "query", "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a user." }, { "info": { "name": "Retrieve a user", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "User UUID" }, { "name": "include", "value": "", "type": "query", "description": "Nested attributes to include. Included objects will return their full\nattributes. Attribute names can be dotted (up to 3 levels) to included deeply\nnested objects." }, { "name": "exclude", "value": "", "type": "query", "description": "Nested attributes to exclude. Excluded objects will return only the href\nattribute. Attribute names can be dotted (up to 3 levels) to exclude deeply\nnested objects." } ] }, "docs": "Returns a single user if the user has access" }, { "info": { "name": "Retrieve the custom metadata of a user", "type": "http" }, "http": { "method": "GET", "url": "https://api.equinix.com/users/:id/customdata", "params": [ { "name": "id", "value": "", "type": "path", "description": "User UUID" } ] }, "docs": "Provides the custom metadata stored for this user in json format" } ] } ], "bundled": true }