# Provider

## GET /organization/{organizationId}/provider

> Returns the relationship provider

```json
{"openapi":"3.0.1","info":{"title":"Elide Service","version":"0.0.1"},"tags":[{"name":"provider"}],"servers":[{"url":"/api/v1"}],"paths":{"/organization/{organizationId}/provider":{"get":{"tags":["provider"],"description":"Returns the relationship provider","parameters":[{"name":"sort","in":"query","description":"Sorts the collection on the selected attributes.  A prefix of '-' sorts descending","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["description","-description","name","-name","id","-id"]}}},{"name":"fields[provider]","in":"query","description":"Selects the set of provider fields that should be returned in the result.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["description","name","organization","version"]}}},{"name":"include","in":"query","description":"Selects the set of relationships that should be expanded as a compound document in the result.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["organization","version"]}}},{"name":"filter[provider]","in":"query","description":"Filters the collection of provider using a 'disjoint' RSQL expression","schema":{"type":"string"}},{"name":"page[number]","in":"query","description":"Number of pages to return.  Can be used with page[size]","schema":{"type":"integer","format":"int32"}},{"name":"page[size]","in":"query","description":"Number of elements per page.  Can be used with page[number]","schema":{"type":"integer","format":"int32"}},{"name":"page[offset]","in":"query","description":"Offset from 0 to start paginating.  Can be used with page[limit]","schema":{"type":"integer","format":"int32"}},{"name":"page[limit]","in":"query","description":"Maximum number of items to return.  Can be used with page[offset]","schema":{"type":"integer","format":"int32"}},{"name":"page[totals]","in":"query","description":"For requesting total pages/records be included in the response page meta data","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/provider"}},"included":{"uniqueItems":true,"type":"array","description":"Included resources","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"type":"object"},"relationships":{"type":"object"}}}}}}}}}}}}},"components":{"schemas":{"provider":{"type":"object","properties":{"type":{"type":"string","description":"Create Permissions : (team manage provider)\nDelete Permissions : (team manage provider)"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"description":{"type":"string","description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false},"name":{"type":"string","description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false}}},"relationships":{"type":"object","properties":{"organization":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["organization"]},"id":{"type":"string"}},"description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false}}}},"version":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["version"]},"id":{"type":"string"}},"description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false}}}}}}}}}}}
```

## POST /organization/{organizationId}/provider

> Creates an item of type provider and adds it to provider

```json
{"openapi":"3.0.1","info":{"title":"Elide Service","version":"0.0.1"},"tags":[{"name":"provider"}],"servers":[{"url":"/api/v1"}],"paths":{"/organization/{organizationId}/provider":{"post":{"tags":["provider"],"description":"Creates an item of type provider and adds it to provider","requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/provider"},"included":{"uniqueItems":true,"type":"array","description":"Included resources","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"type":"object"},"relationships":{"type":"object"}}}}}}}}},"responses":{"201":{"description":"Successful response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/provider"},"included":{"uniqueItems":true,"type":"array","description":"Included resources","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"type":"object"},"relationships":{"type":"object"}}}}}}}}}}}}},"components":{"schemas":{"provider":{"type":"object","properties":{"type":{"type":"string","description":"Create Permissions : (team manage provider)\nDelete Permissions : (team manage provider)"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"description":{"type":"string","description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false},"name":{"type":"string","description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false}}},"relationships":{"type":"object","properties":{"organization":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["organization"]},"id":{"type":"string"}},"description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false}}}},"version":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["version"]},"id":{"type":"string"}},"description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false}}}}}}}}}}}
```

## GET /organization/{organizationId}/provider/{providerId}

> Returns an instance of type provider

```json
{"openapi":"3.0.1","info":{"title":"Elide Service","version":"0.0.1"},"tags":[{"name":"provider"}],"servers":[{"url":"/api/v1"}],"paths":{"/organization/{organizationId}/provider/{providerId}":{"get":{"tags":["provider"],"description":"Returns an instance of type provider","parameters":[{"name":"fields[provider]","in":"query","description":"Selects the set of provider fields that should be returned in the result.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["description","name","organization","version"]}}},{"name":"include","in":"query","description":"Selects the set of relationships that should be expanded as a compound document in the result.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["organization","version"]}}}],"responses":{"200":{"description":"Successful response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/provider"},"included":{"uniqueItems":true,"type":"array","description":"Included resources","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"type":"object"},"relationships":{"type":"object"}}}}}}}}}}}}},"components":{"schemas":{"provider":{"type":"object","properties":{"type":{"type":"string","description":"Create Permissions : (team manage provider)\nDelete Permissions : (team manage provider)"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"description":{"type":"string","description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false},"name":{"type":"string","description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false}}},"relationships":{"type":"object","properties":{"organization":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["organization"]},"id":{"type":"string"}},"description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false}}}},"version":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["version"]},"id":{"type":"string"}},"description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false}}}}}}}}}}}
```

## DELETE /organization/{organizationId}/provider/{providerId}

> Deletes an instance of type provider

```json
{"openapi":"3.0.1","info":{"title":"Elide Service","version":"0.0.1"},"tags":[{"name":"provider"}],"servers":[{"url":"/api/v1"}],"paths":{"/organization/{organizationId}/provider/{providerId}":{"delete":{"tags":["provider"],"description":"Deletes an instance of type provider","responses":{"204":{"description":"Successful response"}}}}}}
```

## PATCH /organization/{organizationId}/provider/{providerId}

> Modifies an instance of type provider

```json
{"openapi":"3.0.1","info":{"title":"Elide Service","version":"0.0.1"},"tags":[{"name":"provider"}],"servers":[{"url":"/api/v1"}],"paths":{"/organization/{organizationId}/provider/{providerId}":{"patch":{"tags":["provider"],"description":"Modifies an instance of type provider","requestBody":{"content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/provider"},"included":{"uniqueItems":true,"type":"array","description":"Included resources","items":{"type":"object","properties":{"type":{"type":"string"},"id":{"type":"string"},"attributes":{"type":"object"},"relationships":{"type":"object"}}}}}}}}},"responses":{"204":{"description":"Successful response"}}}}},"components":{"schemas":{"provider":{"type":"object","properties":{"type":{"type":"string","description":"Create Permissions : (team manage provider)\nDelete Permissions : (team manage provider)"},"id":{"type":"string"},"attributes":{"type":"object","properties":{"description":{"type":"string","description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false},"name":{"type":"string","description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false}}},"relationships":{"type":"object","properties":{"organization":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["organization"]},"id":{"type":"string"}},"description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false}}}},"version":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["version"]},"id":{"type":"string"}},"description":"Read Permissions : (team view provider)\nUpdate Permissions : (team manage provider)","readOnly":false,"writeOnly":false}}}}}}}}}}}
```