Partner Organizations

API

getApi

Top-level resources and operations in this API

Return links to the top-level resources and operations in this API.


/

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///partners/"
import { APIApi } from "@apiture/partner_organizations-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new PartnerOrganizations.APIApi.getApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApi(callback);

Scopes

Parameters

Responses


getApiDoc

Return API definition document

Return the OpenAPI document that describes this API.


/apiDoc

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///partners/apiDoc"
import { APIApi } from "@apiture/partner_organizations-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new PartnerOrganizations.APIApi.getApiDoc()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApiDoc(callback);

Scopes

Parameters

Responses


getLabels

Localized Labels

Return a JSON object which defines labels for enumeration types defined by the schemas defined in this API. The labels in the response may not all match the requested language; some may be in the default language (`en-us`).


/labels

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///partners/labels"
import { APIApi } from "@apiture/partner_organizations-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new PartnerOrganizations.APIApi.getLabels()
var opts = {
  'acceptLanguage': acceptLanguage_example // {String} The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per [RFC 7231](https://tools.ietf.org/html/rfc7231#section-5.3.5).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getLabels(opts, callback);

Scopes

Parameters

Header parameters
Name Description
Accept-Language
String
The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per [RFC 7231](https://tools.ietf.org/html/rfc7231#section-5.3.5).

Responses


PartnerOrganization

activateOrganization

Activate a partner organization.

Activate a partner organization from an inactive state. <p> This operation is invoked from the `apiture:activate` link on an organization resource when that partner resource is eligible to be activated. <p> This changes the `state` to `active`.


/activeOrganizations

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///partners/activeOrganizations?organization="
import { PartnerOrganizationApi } from "@apiture/partner_organizations-client-sdk";

const partnerOrganizationApi = new PartnerOrganizationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
partnerOrganizationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
partnerOrganizationApi.setApiKey(apiKey);


var api = new PartnerOrganizations.PartnerOrganizationApi.activateOrganization()
var organization = organization_example; // {String} A string which identifies existing organization whose state is being changed by `POST`ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a `{organizationId}` or a organization URI.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
partnerOrganizationApi.activateOrganization(organization, opts, callback);

Scopes

profiles/read Read access to partner related resources.
profiles/write Write (update) access to partner related resources.
admin/delete Administrator delete access to partner related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to partner related resources.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Query parameters
Name Description
organization*
String
A string which identifies existing organization whose state is being changed by `POST`ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a `{organizationId}` or a organization URI.
Required

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this partner organization resource.


createOrganization

Create a new organization

Create a new organization in the organizations collection.


/organizations

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///partners/organizations"
import { PartnerOrganizationApi } from "@apiture/partner_organizations-client-sdk";

const partnerOrganizationApi = new PartnerOrganizationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
partnerOrganizationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
partnerOrganizationApi.setApiKey(apiKey);


var api = new PartnerOrganizations.PartnerOrganizationApi.createOrganization()
var createOrganization = ; // {CreateOrganization} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
partnerOrganizationApi.createOrganization(createOrganization, callback);

Scopes

profiles/read Read access to partner related resources.
profiles/write Write (update) access to partner related resources.
admin/delete Administrator delete access to partner related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to partner related resources.

Parameters

Body parameters
Name Description
createOrganization *

The data necessary to create a new organization.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deactivateOrganization

Deactivate a partner organization.

Deactivate a partner organization from an active state. <p> This operation is invoked from the `apiture:deactivate` link on an organization resource when that partner organization is eligible to be deactivated. <p> This changes the `state` to `inactive`.


/inactiveOrganizations

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///partners/inactiveOrganizations?organization="
import { PartnerOrganizationApi } from "@apiture/partner_organizations-client-sdk";

const partnerOrganizationApi = new PartnerOrganizationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
partnerOrganizationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
partnerOrganizationApi.setApiKey(apiKey);


var api = new PartnerOrganizations.PartnerOrganizationApi.deactivateOrganization()
var organization = organization_example; // {String} A string which identifies existing organization whose state is being changed by `POST`ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a `{organizationId}` or a organization URI.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
partnerOrganizationApi.deactivateOrganization(organization, opts, callback);

Scopes

profiles/read Read access to partner related resources.
profiles/write Write (update) access to partner related resources.
admin/delete Administrator delete access to partner related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to partner related resources.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Query parameters
Name Description
organization*
String
A string which identifies existing organization whose state is being changed by `POST`ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a `{organizationId}` or a organization URI.
Required

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this partner organization resource.


deleteOrganization

Delete this organization resource

Delete this organization resource. Most callers do not have delete access. (Admin users have delete access to all partner organizations.)


/organizations/{organizationId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///partners/organizations/{organizationId}"
import { PartnerOrganizationApi } from "@apiture/partner_organizations-client-sdk";

const partnerOrganizationApi = new PartnerOrganizationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
partnerOrganizationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
partnerOrganizationApi.setApiKey(apiKey);


var api = new PartnerOrganizations.PartnerOrganizationApi.deleteOrganization()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
partnerOrganizationApi.deleteOrganization(organizationId, opts, callback);

Scopes

profiles/read Read access to partner related resources.
profiles/write Write (update) access to partner related resources.
admin/delete Administrator delete access to partner related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to partner related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.

Responses


getOrganization

Fetch a representation of this organization

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this organization resource. Most callers have access only to their own partner organization, based on their email address domain. (Admin users have access to all partner organizations.)


/organizations/{organizationId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///partners/organizations/{organizationId}"
import { PartnerOrganizationApi } from "@apiture/partner_organizations-client-sdk";

const partnerOrganizationApi = new PartnerOrganizationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
partnerOrganizationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
partnerOrganizationApi.setApiKey(apiKey);


var api = new PartnerOrganizations.PartnerOrganizationApi.getOrganization()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
partnerOrganizationApi.getOrganization(organizationId, opts, callback);

Scopes

profiles/read Read access to partner related resources.
profiles/write Write (update) access to partner related resources.
admin/delete Administrator delete access to partner related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to partner related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this organization resource.


getOrganizations

Return a collection of organizations

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [filterable](https://developer.apiture.com/docs/concepts/filtering) collection of organizations. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links. The result is limited to partner organizations that the caller has access to (usually, their own partner organization) based on their email address domain. (Admin users have access to all partner organizations.)


/organizations

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///partners/organizations?start=&limit=&filter=&domain=&type=&state=&name="
import { PartnerOrganizationApi } from "@apiture/partner_organizations-client-sdk";

const partnerOrganizationApi = new PartnerOrganizationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
partnerOrganizationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
partnerOrganizationApi.setApiKey(apiKey);


var api = new PartnerOrganizations.PartnerOrganizationApi.getOrganizations()
var opts = {
  'start': start_example, // {String} Represents the first record of the page of results. This is supplied by the service when paginating items: the `next` link includes a `?start=` query parameter which refers to beginning of the next page of items.
  'limit': 56, // {Integer} The maximum number of organization representations to return in this page.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'domain': domain_example, // {String} Subset the result to match only partner organizations whose `domain` property matches this value. This is combined with the `filter` query, if any, via and implicit `and`. Note that for most users, the collection is already implicitly filtered to their organization.
  'type': type_example, // {String} Subset the organizations collection to those with this exact type value. Use | to separate multiple values. For example, `?type=corporation` will match only items whose type is `corporation`; `?type=llp|llc` will match items whose type is `llp` or `llc`. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'state': , // {array[String]} Subset the resources to only those whose `state` matches the query, such as `?state=active`. The value may be a `|` separated list of states, such as `?state=pending|active` to match all resources whose `state` is either `pending` _or_ `active`. If `?filter=` is also used, the two are combined with an implicit `and()` operation.
  'name': name_example // {String} Subset the organizations collection to those with this name value. Use | to separate multiple values. For example, ?name=Bartell will match only items whose name is Bartell; ?name=Bartell|kirsten will match items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
partnerOrganizationApi.getOrganizations(opts, callback);

Scopes

profiles/read Read access to partner related resources.
profiles/write Write (update) access to partner related resources.
admin/delete Administrator delete access to partner related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to partner related resources.

Parameters

Query parameters
Name Description
start
String
Represents the first record of the page of results. This is supplied by the service when paginating items: the `next` link includes a `?start=` query parameter which refers to beginning of the next page of items.
limit
Integer (int32)
The maximum number of organization representations to return in this page.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
domain
String
Subset the result to match only partner organizations whose `domain` property matches this value. This is combined with the `filter` query, if any, via and implicit `and`. Note that for most users, the collection is already implicitly filtered to their organization.
type
String
Subset the organizations collection to those with this exact type value. Use | to separate multiple values. For example, `?type=corporation` will match only items whose type is `corporation`; `?type=llp|llc` will match items whose type is `llp` or `llc`. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
state
array[String]
Subset the resources to only those whose `state` matches the query, such as `?state=active`. The value may be a `|` separated list of states, such as `?state=pending|active` to match all resources whose `state` is either `pending` _or_ `active`. If `?filter=` is also used, the two are combined with an implicit `and()` operation.
name
String
Subset the organizations collection to those with this name value. Use | to separate multiple values. For example, ?name=Bartell will match only items whose name is Bartell; ?name=Bartell|kirsten will match items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).

Responses


inviteMembers

Invite new members

Invite new members to this partner organization. This operation sends the invitees an invitation email. This API does not track which people it has sent invitations to; it unconditionally emails each invitee even if they have been invited in the past or are already registered. When the recipients register on the developer portal with an email address with the same partner `domain`, they are automatically added to the organization. TODO: Provide API to remove members (i.e. if they leave the organization.)


/organizations/{organizationId}/memberInvitations

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///partners/organizations/{organizationId}/memberInvitations"
import { PartnerOrganizationApi } from "@apiture/partner_organizations-client-sdk";

const partnerOrganizationApi = new PartnerOrganizationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
partnerOrganizationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
partnerOrganizationApi.setApiKey(apiKey);


var api = new PartnerOrganizations.PartnerOrganizationApi.inviteMembers()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var createInvitation = ; // {CreateInvitation} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
partnerOrganizationApi.inviteMembers(organizationId, createInvitation, callback);

Scopes

profiles/read Read access to partner related resources.
profiles/write Write (update) access to partner related resources.
admin/delete Administrator delete access to partner related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to partner related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
Body parameters
Name Description
createInvitation *

The data necessary to invite one or more new members.

Responses


patchOrganization

Update this organization

Perform a partial update of this organization. Fields which are omitted are not updated. Nested `_embedded` and `_links` are ignored if included. Most callers have access only to their own partner organization, based on their email address domain. (Admin users have access to all partner organizations.)


/organizations/{organizationId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///partners/organizations/{organizationId}"
import { PartnerOrganizationApi } from "@apiture/partner_organizations-client-sdk";

const partnerOrganizationApi = new PartnerOrganizationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
partnerOrganizationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
partnerOrganizationApi.setApiKey(apiKey);


var api = new PartnerOrganizations.PartnerOrganizationApi.patchOrganization()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var organization = ; // {Organization} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
partnerOrganizationApi.patchOrganization(organizationId, organization, opts, callback);

Scopes

profiles/read Read access to partner related resources.
profiles/write Write (update) access to partner related resources.
admin/delete Administrator delete access to partner related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to partner related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
organization *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this organization resource.


removeOrganization

Remove a partner organization.

Remove a partner organization by setting its state to `removed`. <p> This operation is invoked from the `apiture:remove` link on a organization resource when that resource is eligible to be removed. The organization must not be in use (there may not be any active associations to the organization). <p> This changes the `state` to `removed`.


/removedOrganizations

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///partners/removedOrganizations?organization="
import { PartnerOrganizationApi } from "@apiture/partner_organizations-client-sdk";

const partnerOrganizationApi = new PartnerOrganizationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
partnerOrganizationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
partnerOrganizationApi.setApiKey(apiKey);


var api = new PartnerOrganizations.PartnerOrganizationApi.removeOrganization()
var organization = organization_example; // {String} A string which identifies existing organization whose state is being changed by `POST`ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a `{organizationId}` or a organization URI.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
partnerOrganizationApi.removeOrganization(organization, opts, callback);

Scopes

profiles/read Read access to partner related resources.
profiles/write Write (update) access to partner related resources.
admin/delete Administrator delete access to partner related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to partner related resources.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Query parameters
Name Description
organization*
String
A string which identifies existing organization whose state is being changed by `POST`ing it to a resource set. The server supplies this value when returning a link to operate on a specific organization. The value may be a `{organizationId}` or a organization URI.
Required

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this partner organization resource.


updateOrganization

Update this organization

Perform a complete replacement of this organization. Most callers have access only to their own partner organization, based on their email address domain. (Admin users have access to all partner organizations.)


/organizations/{organizationId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///partners/organizations/{organizationId}"
import { PartnerOrganizationApi } from "@apiture/partner_organizations-client-sdk";

const partnerOrganizationApi = new PartnerOrganizationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
partnerOrganizationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
partnerOrganizationApi.setApiKey(apiKey);


var api = new PartnerOrganizations.PartnerOrganizationApi.updateOrganization()
var organizationId = organizationId_example; // {String} The unique identifier of this organization. This is an opaque string.
var organization = ; // {Organization} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
partnerOrganizationApi.updateOrganization(organizationId, organization, opts, callback);

Scopes

profiles/read Read access to partner related resources.
profiles/write Write (update) access to partner related resources.
admin/delete Administrator delete access to partner related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to partner related resources.

Parameters

Path parameters
Name Description
organizationId*
String
The unique identifier of this organization. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. This must match the current entity tag of the resource.
Body parameters
Name Description
organization *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this organization resource.


validatePartnerDomain

Validate a partner domain name

Check if a partner domain is valid. Some domains are not valid for use in the developer portal, such as those assocated with generic email services (`gmail.com`, `outlook.com`, `yahoo.com`, `aol.com`, and so on). The domain is passed as a query parameter. The 200 response is a JSON object, and the `_error` will be populated if the domain is not valid.


/domainValidations

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///partners/domainValidations?domain="
import { PartnerOrganizationApi } from "@apiture/partner_organizations-client-sdk";

const partnerOrganizationApi = new PartnerOrganizationApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
partnerOrganizationApi.setApiKey(apiKey);


var api = new PartnerOrganizations.PartnerOrganizationApi.validatePartnerDomain()
var domain = domain_example; // {String} A candidate partner domain, such as `example.com` or `apiture.com`. This is typically taked from the user's email address, following the `@` character.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
partnerOrganizationApi.validatePartnerDomain(domain, callback);

Scopes

Parameters

Query parameters
Name Description
domain*
String
A candidate partner domain, such as `example.com` or `apiture.com`. This is typically taked from the user's email address, following the `@` character.
Required

Responses