{
  "opencollection": "1.0.0",
  "info": {
    "name": "Metal Authentication Organizations API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Auth-Token",
      "value": "{{X-Auth-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Organizations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve all organizations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/organizations",
            "params": [
              {
                "name": "personal",
                "value": "",
                "type": "query",
                "description": "Include, exclude or show only personal organizations."
              },
              {
                "name": "without_projects",
                "value": "",
                "type": "query",
                "description": "Include, exclude or show only organizations that have no projects."
              },
              {
                "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 organizations that are accessible to the current user."
        },
        {
          "info": {
            "name": "Create an organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/metal/v1/organizations",
            "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 an organization."
        },
        {
          "info": {
            "name": "Retrieve an organization's details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/organizations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Organization 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 organization's details, if the user is authorized to view it."
        },
        {
          "info": {
            "name": "Update the organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.equinix.com/metal/v1/organizations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Organization 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."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the organization."
        },
        {
          "info": {
            "name": "Delete the organization",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.equinix.com/metal/v1/organizations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Organization UUID"
              }
            ]
          },
          "docs": "Deletes the organization."
        },
        {
          "info": {
            "name": "Retrieve the custom metadata of an organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/organizations/:id/customdata",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Organization UUID"
              }
            ]
          },
          "docs": "Provides the custom metadata stored for this organization in json format"
        },
        {
          "info": {
            "name": "Retrieve organization invitations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/organizations/:id/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"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Organization UUID"
              }
            ]
          },
          "docs": "Returns all invitations in an organization."
        },
        {
          "info": {
            "name": "Create an invitation for an organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/metal/v1/organizations/:id/invitations",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Organization 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."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "In order to add a user to an organization, they must first be invited.\nTo invite to several projects the parameter `projects_ids:[a,b,c]` can be used"
        },
        {
          "info": {
            "name": "Retrieve all operating systems visible by the organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/organizations/:id/operating-systems",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Organization 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."
              }
            ]
          },
          "docs": "Returns a listing of available operating systems for the given organization"
        },
        {
          "info": {
            "name": "Retrieve all payment methods of an organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/organizations/:id/payment-methods",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Organization 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": "page",
                "value": "",
                "type": "query",
                "description": "Page to return"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Items returned per page"
              }
            ]
          },
          "docs": "Returns all payment methods of an organization."
        },
        {
          "info": {
            "name": "Create a payment method for the given organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/metal/v1/organizations/:id/payment-methods",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Organization 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."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a payment method."
        },
        {
          "info": {
            "name": "Retrieve all plans visible by the organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/organizations/:id/plans",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Organization 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 listing of available plans for the given organization"
        },
        {
          "info": {
            "name": "Retrieve all projects of an organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/organizations/:id/projects",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Organization UUID"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Filter results by name."
              },
              {
                "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 collection of projects that belong to the organization."
        },
        {
          "info": {
            "name": "Create a project for the organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.equinix.com/metal/v1/organizations/:id/projects",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Organization 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."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new project for the organization"
        },
        {
          "info": {
            "name": "Retrieve all project transfer requests from or to an organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.equinix.com/metal/v1/organizations/:id/transfers",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Organization 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."
              }
            ]
          },
          "docs": "Provides a collection of project transfer requests from or to the organization."
        }
      ]
    }
  ],
  "bundled": true
}