IBM Cloud API Docs

Introduction

Last updated: 2020-04-13

API Connect is an integrated API management offering, with capabilities and tooling for all phases of the API lifecycle. Key steps of the API lifecycle include: create, secure, manage, socialize, and analyze.

These APIs enable you to permform actions as a consumer of the APIs that are published through the {{site.data.keyword.apiconnect}} service; for example, retrieve a list of Products, or subscribe to a product.

For more information on using API Connect, see: Getting started.

Authentication

Most API methods require an Authorization header that includes a token with your IBM Cloud Identity and Access Management (IAM) credentials.

The header should look like this: Authorization: Bearer <token>

For more information, see Passing an IBM Cloud IAM token to authenticate with a service's API

Error handling

The APIs that you create and manage with API Connect use standard HTTP response codes to indicate whether a method completed successfully.

HTTP Error Code Description Recovery
200 Success The request was successful.
400 Bad Request The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
401 Unauthorized You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact your account owner to check your permissions.
403 Forbidden The supplied authentication is not authorized.
404 Not Found The requested resource could not be found.
408 Request Timeout The connection to the server timed out. Wait a few minutes, then try again.
409 Conflict The entity is already in the requested state.
429 Too Many Requests You have made too many requests to this endpoint and are being rate limited / throttled.
500 Internal Server Error App ID is currently unavailable. Your request could not be processed. Wait a few minutes and try again.

Methods

Get the Me object

Get the Me object

GET /me

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • expand
    boolean

    Expand the response object

Response

Response Body

Me

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Me object

Update the Me object

PUT /me

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

Me

Response

Response Body

Me

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Me object

Delete the Me object

DELETE /me

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Response

Response Body

Me

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Change my password

Change my password

POST /me/change-password

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

ChangePassword

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset password

Reset password

POST /me/reset-password

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

ResetPassword

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Sign out

Sign out

POST /me/sign-out

Request

No Request Parameters

This method does not accept any request parameters.

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the My Permission objects

List the My Permission objects

GET /permissions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MyPermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a My Organization object

Create a My Organization object

POST /orgs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

Org

Response

Response Body

Org

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the My Organization objects

List the My Organization objects

GET /orgs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

OrgList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Me object

Get the Me object

GET /me

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • expand
    boolean

    Expand the response object

Response

Response Body

Me

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Me object

Update the Me object

PUT /me

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

Me

Response

Response Body

Me

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Me object

Delete the Me object

DELETE /me

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Response

Response Body

Me

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Change my password

Change my password

POST /me/change-password

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

ChangePassword

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset password

Reset password

POST /me/reset-password

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

ResetPassword

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Sign out

Sign out

POST /me/sign-out

Request

No Request Parameters

This method does not accept any request parameters.

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the My Permission objects

List the My Permission objects

GET /permissions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MyPermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a My Organization object

Create a My Organization object

POST /orgs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

Org

Response

Response Body

Org

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the My Organization objects

List the My Organization objects

GET /orgs

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

OrgList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Permission objects in all collections

List all Permission objects in all collections

GET /consumer/permissions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Permission objects

List the Permission objects

GET /consumer/permissions/org

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Permission object by name or id

Get the Permission object by name or id

GET /consumer/permissions/org/{permission}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • permission
    Required*
    string

    Permission name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Permission

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Permission objects

List the Permission objects

GET /consumer/permissions/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Permission object by name or id

Get the Permission object by name or id

GET /consumer/permissions/consumer/{permission}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • permission
    Required*
    string

    Permission name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Permission

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Organization object by name or id

Get the Organization object by name or id

GET /orgs/{org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Org

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Organization object by name or id

Update the Organization object by name or id

PATCH /orgs/{org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Org

Response

Response Body

Org

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Organization object by name or id

Delete the Organization object by name or id

DELETE /orgs/{org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • cascade
    boolean

    Cascade the behavior

Response

Response Body

Org

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Transfer owner to a new member

Transfer owner to a new member

POST /orgs/{org}/transfer-owner

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

TransferOwner

Response

Response Body

Org

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Register using the Organization Invitation

Register using the Organization Invitation

POST /org-invitations/{invitation}/register

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • invitation
    Required*
    string

    Organization Invitation name or id

Request Body

InvitationRegister

Response

Response Body

MemberRegisterResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Accept using the Organization Invitation

Accept using the Organization Invitation

POST /org-invitations/{invitation}/accept

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • invitation
    Required*
    string

    Organization Invitation name or id

Request Body

InvitationAccept

Response

Response Body

MemberAcceptResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member Invitation object

Create a Member Invitation object

POST /orgs/{org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member Invitation objects

List the Member Invitation objects

GET /orgs/{org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberInvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member Invitation objects

Clear the Member Invitation objects

DELETE /orgs/{org}/member-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    string

    confirm clear

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member Invitation object by name or id

Get the Member Invitation object by name or id

GET /orgs/{org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member Invitation object by name or id

Delete the Member Invitation object by name or id

DELETE /orgs/{org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Response

Response Body

MemberInvitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Member Invitation

Regenerate the Member Invitation

POST /orgs/{org}/member-invitations/{member-invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

Regenerate

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Register using the Member Invitation

Register using the Member Invitation

POST /orgs/{org}/member-invitations/{member-invitation}/register

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationRegister

Response

Response Body

MemberRegisterResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Accept using the Member Invitation

Accept using the Member Invitation

POST /orgs/{org}/member-invitations/{member-invitation}/accept

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationAccept

Response

Response Body

MemberAcceptResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Associate objects

List the Associate objects

GET /orgs/{org}/associates

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AssociateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Associate object by name or id

Get the Associate object by name or id

GET /orgs/{org}/associates/{associate}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • associate
    Required*
    string

    Associate name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Associate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member object

Create a Member object

POST /orgs/{org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member objects

List the Member objects

GET /orgs/{org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member objects

Clear the Member objects

DELETE /orgs/{org}/members

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    string

    confirm clear

  • cascade
    boolean

    Cascade the behavior

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member object by name or id

Get the Member object by name or id

GET /orgs/{org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member
    Required*
    string

    Member name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member object by name or id

Update the Member object by name or id

PATCH /orgs/{org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member
    Required*
    string

    Member name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member object by name or id

Delete the Member object by name or id

DELETE /orgs/{org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member
    Required*
    string

    Member name or id

Query Parameters

  • cascade
    boolean

    Cascade the behavior

Response

Response Body

Member

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Role object

Create a Role object

POST /orgs/{org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role objects

List the Role objects

GET /orgs/{org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Role objects

Clear the Role objects

DELETE /orgs/{org}/roles

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    string

    confirm clear

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role object by name or id

Get the Role object by name or id

GET /orgs/{org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • role
    Required*
    string

    Role name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role object by name or id

Update the Role object by name or id

PATCH /orgs/{org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • role
    Required*
    string

    Role name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Role object by name or id

Delete the Role object by name or id

DELETE /orgs/{org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • role
    Required*
    string

    Role name or id

Response

Response Body

Role

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Payment Method object

Create a Payment Method object

POST /orgs/{org}/payment-methods

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

PaymentMethod

Response

Response Body

PaymentMethod

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Payment Method objects

List the Payment Method objects

GET /orgs/{org}/payment-methods

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PaymentMethodList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Payment Method object by name or id

Get the Payment Method object by name or id

GET /orgs/{org}/payment-methods/{payment-method}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • payment-method
    Required*
    string

    Payment Method name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

PaymentMethod

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Payment Method object by name or id

Update the Payment Method object by name or id

PATCH /orgs/{org}/payment-methods/{payment-method}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • payment-method
    Required*
    string

    Payment Method name or id

Request Body

PaymentMethod

Response

Response Body

PaymentMethod

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Permission objects in all collections

List all Permission objects in all collections

GET /consumer/permissions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Permission objects

List the Permission objects

GET /consumer/permissions/org

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Permission object by name or id

Get the Permission object by name or id

GET /consumer/permissions/org/{permission}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • permission
    Required*
    string

    Permission name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Permission

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Permission objects

List the Permission objects

GET /consumer/permissions/consumer

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PermissionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Permission object by name or id

Get the Permission object by name or id

GET /consumer/permissions/consumer/{permission}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • permission
    Required*
    string

    Permission name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Permission

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Generate a token

Generate a token

POST /token

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

TokenRequest

Response

Response Body

TokenResponse

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

APIC authorization endpoint

APIC authorize endpoint

GET /oauth2/authorize

Request

Query Parameters

  • realm
    Required*
    string

    User registry realm name

  • response_type
    Required*
    string

    Oauth2 response_type

  • client_id
    string

    Registration client identifier

  • state
    string

    Oauth2 state

  • redirect_uri
    string

    Redirect Url

  • token
    string

    token

  • name
    string

    token

  • title
    string

    token

  • summary
    string

    token

  • invitation_scope
    string

    token

Response

Status Code

  • 302

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the User Registry objects

List the User Registry objects

GET /user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

UserRegistryList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the User Registry object by name or id

Get the User Registry object by name or id

GET /user-registries/{user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • user-registry
    Required*
    string

    User Registry name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

UserRegistry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Search for users in the user registry

Search for users in the user registry

POST /user-registries/{user-registry}/search

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • user-registry
    Required*
    string

    User Registry name or id

Query Parameters

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Request Body

UserSearch

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the User object by name or id

Get the User object by name or id

GET /user-registries/{user-registry}/users/{user}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • user-registry
    Required*
    string

    User Registry name or id

  • user
    Required*
    string

    User name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

User

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Sign up a user

Sign up a user

POST /sign-up

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

SignUp

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Activates the sign up

Activates the sign up

POST /activate

Request

Query Parameters

  • activation_id
    Required*
    string

    Activation name or id

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Send reset password link

Send reset password link

POST /request-password-reset

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

RequestPasswordReset

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Generate a token

Generate a token

POST /token

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

TokenRequest

Response

Response Body

TokenResponse

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Authorization provider redirect endpoint

Authorization provider redirect endpoint

GET /oauth2/redirect

Request

Query Parameters

  • state
    string

    Oauth2 state

  • code
    string

    Oauth2 code

  • error
    string

    Oauth2 error

  • error_description
    string

    Oauth2 error_description

  • error_uri
    string

    Oauth2 error_uri

  • oauth_token
    string

    Oauth Token for Twitter

  • oauth_verifier
    string

    Oauth Verifier for Twitter

Response

Status Code

  • 302

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Authorization provider redirect endpoint

Authorization provider redirect endpoint

POST /oauth2/redirect

Request

Query Parameters

  • state
    string

    Oauth2 state

  • code
    string

    Oauth2 code

  • error
    string

    Oauth2 error

  • error_description
    string

    Oauth2 error_description

  • error_uri
    string

    Oauth2 error_uri

  • oauth_token
    string

    Oauth Token for Twitter

  • oauth_verifier
    string

    Oauth Verifier for Twitter

Form Parameters

  • code
    string
  • state
    string
  • error
    string
  • error_description
    string
  • error_uri
    string

Response

Status Code

  • 302

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Authorization provider redirect endpoint

Authorization provider redirect endpoint

GET /oauth2/redirect

Request

Query Parameters

  • state
    string

    Oauth2 state

  • code
    string

    Oauth2 code

  • error
    string

    Oauth2 error

  • error_description
    string

    Oauth2 error_description

  • error_uri
    string

    Oauth2 error_uri

  • oauth_token
    string

    Oauth Token for Twitter

  • oauth_verifier
    string

    Oauth Verifier for Twitter

Response

Status Code

  • 302

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Authorization provider redirect endpoint

Authorization provider redirect endpoint

POST /oauth2/redirect

Request

Query Parameters

  • state
    string

    Oauth2 state

  • code
    string

    Oauth2 code

  • error
    string

    Oauth2 error

  • error_description
    string

    Oauth2 error_description

  • error_uri
    string

    Oauth2 error_uri

  • oauth_token
    string

    Oauth Token for Twitter

  • oauth_verifier
    string

    Oauth Verifier for Twitter

Form Parameters

  • code
    string
  • state
    string
  • error
    string
  • error_description
    string
  • error_uri
    string

Response

Status Code

  • 302

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

APIC authorization endpoint

APIC authorize endpoint

GET /oauth2/authorize

Request

Query Parameters

  • realm
    Required*
    string

    User registry realm name

  • response_type
    Required*
    string

    Oauth2 response_type

  • client_id
    string

    Registration client identifier

  • state
    string

    Oauth2 state

  • redirect_uri
    string

    Redirect Url

  • token
    string

    token

  • name
    string

    token

  • title
    string

    token

  • summary
    string

    token

  • invitation_scope
    string

    token

Response

Status Code

  • 302

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Organization object by name or id

Get the Organization object by name or id

GET /orgs/{org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Org

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Organization object by name or id

Update the Organization object by name or id

PATCH /orgs/{org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Org

Response

Response Body

Org

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Organization object by name or id

Delete the Organization object by name or id

DELETE /orgs/{org}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • cascade
    boolean

    Cascade the behavior

Response

Response Body

Org

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Transfer owner to a new member

Transfer owner to a new member

POST /orgs/{org}/transfer-owner

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

TransferOwner

Response

Response Body

Org

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Group object by name or id

Get the Group object by name or id

GET /groups/{group}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • group
    Required*
    string

    Group name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Group

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Group object by name or id

Get the Group object by name or id

GET /groups/{group}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • group
    Required*
    string

    Group name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Group

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Register using the Organization Invitation

Register using the Organization Invitation

POST /org-invitations/{invitation}/register

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • invitation
    Required*
    string

    Organization Invitation name or id

Request Body

InvitationRegister

Response

Response Body

MemberRegisterResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Accept using the Organization Invitation

Accept using the Organization Invitation

POST /org-invitations/{invitation}/accept

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • invitation
    Required*
    string

    Organization Invitation name or id

Request Body

InvitationAccept

Response

Response Body

MemberAcceptResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member Invitation object

Create a Member Invitation object

POST /orgs/{org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

MemberInvitation

Response

Response Body

MemberInvitation

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member Invitation objects

List the Member Invitation objects

GET /orgs/{org}/member-invitations

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberInvitationList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member Invitation objects

Clear the Member Invitation objects

DELETE /orgs/{org}/member-invitations

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    string

    confirm clear

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member Invitation object by name or id

Get the Member Invitation object by name or id

GET /orgs/{org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member Invitation object by name or id

Delete the Member Invitation object by name or id

DELETE /orgs/{org}/member-invitations/{member-invitation}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Response

Response Body

MemberInvitation

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Regenerate the Member Invitation

Regenerate the Member Invitation

POST /orgs/{org}/member-invitations/{member-invitation}/regenerate

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

Regenerate

Response

Response Body

MemberInvitation

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Register using the Member Invitation

Register using the Member Invitation

POST /orgs/{org}/member-invitations/{member-invitation}/register

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationRegister

Response

Response Body

MemberRegisterResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Accept using the Member Invitation

Accept using the Member Invitation

POST /orgs/{org}/member-invitations/{member-invitation}/accept

Request

Custom Headers

  • X-IBM-Client-Id
    string

    Registration client identifier

  • X-IBM-Client-Secret
    string

    Registration client secret

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member-invitation
    Required*
    string

    Member Invitation name or id

Request Body

MemberInvitationAccept

Response

Response Body

MemberAcceptResponse

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the User Registry objects

List the User Registry objects

GET /user-registries

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

UserRegistryList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the User Registry object by name or id

Get the User Registry object by name or id

GET /user-registries/{user-registry}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • user-registry
    Required*
    string

    User Registry name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

UserRegistry

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Search for users in the user registry

Search for users in the user registry

POST /user-registries/{user-registry}/search

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • user-registry
    Required*
    string

    User Registry name or id

Query Parameters

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Request Body

UserSearch

Response

Response Body

UserList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the User object by name or id

Get the User object by name or id

GET /user-registries/{user-registry}/users/{user}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • user-registry
    Required*
    string

    User Registry name or id

  • user
    Required*
    string

    User name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

User

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Sign up a user

Sign up a user

POST /sign-up

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

SignUp

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Activates the sign up

Activates the sign up

POST /activate

Request

Query Parameters

  • activation_id
    Required*
    string

    Activation name or id

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Send reset password link

Send reset password link

POST /request-password-reset

Request

Custom Headers

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Request Body

RequestPasswordReset

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List Identity Providers in the consumer realm

List Identity Providers in the consumer realm

GET /consumer/identity-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

IdentityProviderList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List Identity Providers in the consumer realm

List Identity Providers in the consumer realm

GET /consumer/identity-providers

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

IdentityProviderList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Associate objects

List the Associate objects

GET /orgs/{org}/associates

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AssociateList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Associate object by name or id

Get the Associate object by name or id

GET /orgs/{org}/associates/{associate}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • associate
    Required*
    string

    Associate name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Associate

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Member object

Create a Member object

POST /orgs/{org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Member objects

List the Member objects

GET /orgs/{org}/members

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

MemberList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Member objects

Clear the Member objects

DELETE /orgs/{org}/members

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    string

    confirm clear

  • cascade
    boolean

    Cascade the behavior

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Member object by name or id

Get the Member object by name or id

GET /orgs/{org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member
    Required*
    string

    Member name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Member object by name or id

Update the Member object by name or id

PATCH /orgs/{org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member
    Required*
    string

    Member name or id

Request Body

Member

Response

Response Body

Member

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Member object by name or id

Delete the Member object by name or id

DELETE /orgs/{org}/members/{member}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • member
    Required*
    string

    Member name or id

Query Parameters

  • cascade
    boolean

    Cascade the behavior

Response

Response Body

Member

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Role object

Create a Role object

POST /orgs/{org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Role objects

List the Role objects

GET /orgs/{org}/roles

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

RoleList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Role objects

Clear the Role objects

DELETE /orgs/{org}/roles

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    string

    confirm clear

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Role object by name or id

Get the Role object by name or id

GET /orgs/{org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • role
    Required*
    string

    Role name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Role object by name or id

Update the Role object by name or id

PATCH /orgs/{org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • role
    Required*
    string

    Role name or id

Request Body

Role

Response

Response Body

Role

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Role object by name or id

Delete the Role object by name or id

DELETE /orgs/{org}/roles/{role}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • role
    Required*
    string

    Role name or id

Response

Response Body

Role

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Product objects in all collections

List all Product objects in all collections

GET /public-products

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Product objects

List the Product objects

GET /public-products/{product-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-name
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by id

Get the Product object by id

GET /public-products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-id
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    field name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by name and version

Get the Product object by name and version

GET /public-products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Query Parameters

  • fields
    string

    field name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document

Get the Product document

GET /public-products/{product-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-id
    Required*
    string

    Product name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document by name and version

Get the Product document by name and version

GET /public-products/{product-name}/{product-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all API objects in all collections

List all API objects in all collections

GET /public-apis

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the API objects

List the API objects

GET /public-apis/{api-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-name
    Required*
    string

    API name

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by id

Get the API object by id

GET /public-apis/{api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-id
    Required*
    string

    API name

Query Parameters

  • fields
    string

    field name

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by name and version

Get the API object by name and version

GET /public-apis/{api-name}/{api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Query Parameters

  • fields
    string

    field name

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document

Get the API document

GET /public-apis/{api-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-id
    Required*
    string

    API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document by name and version

Get the API document by name and version

GET /public-apis/{api-name}/{api-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document

Get the API wsdl document

GET /public-apis/{api-id}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • api-id
    Required*
    string

    API name

Query Parameters

  • endpoint
    string

    endpoint

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document by name and version

Get the API wsdl document by name and version

GET /public-apis/{api-name}/{api-version}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Query Parameters

  • endpoint
    string

    endpoint

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Product objects in all collections

List all Product objects in all collections

GET /products

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Product objects

List the Product objects

GET /products/{product-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-name
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by id

Get the Product object by id

GET /products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-id
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    field name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by name and version

Get the Product object by name and version

GET /products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Query Parameters

  • fields
    string

    field name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document

Get the Product document

GET /products/{product-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-id
    Required*
    string

    Product name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document by name and version

Get the Product document by name and version

GET /products/{product-name}/{product-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all API objects in all collections

List all API objects in all collections

GET /apis

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the API objects

List the API objects

GET /apis/{api-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-name
    Required*
    string

    API name

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by id

Get the API object by id

GET /apis/{api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-id
    Required*
    string

    API name

Query Parameters

  • fields
    string

    field name

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by name and version

Get the API object by name and version

GET /apis/{api-name}/{api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Query Parameters

  • fields
    string

    field name

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document

Get the API document

GET /apis/{api-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-id
    Required*
    string

    API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document by name and version

Get the API document by name and version

GET /apis/{api-name}/{api-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document

Get the API wsdl document

GET /apis/{api-id}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • api-id
    Required*
    string

    API name

Query Parameters

  • endpoint
    string

    endpoint

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document by name and version

Get the API wsdl document by name and version

GET /apis/{api-name}/{api-version}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Query Parameters

  • endpoint
    string

    endpoint

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Product objects in all collections

List all Product objects in all collections

GET /public-products

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Product objects

List the Product objects

GET /public-products/{product-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-name
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by id

Get the Product object by id

GET /public-products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-id
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    field name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by name and version

Get the Product object by name and version

GET /public-products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Query Parameters

  • fields
    string

    field name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document

Get the Product document

GET /public-products/{product-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-id
    Required*
    string

    Product name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document by name and version

Get the Product document by name and version

GET /public-products/{product-name}/{product-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all API objects in all collections

List all API objects in all collections

GET /public-apis

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the API objects

List the API objects

GET /public-apis/{api-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-name
    Required*
    string

    API name

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by id

Get the API object by id

GET /public-apis/{api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-id
    Required*
    string

    API name

Query Parameters

  • fields
    string

    field name

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by name and version

Get the API object by name and version

GET /public-apis/{api-name}/{api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Query Parameters

  • fields
    string

    field name

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document

Get the API document

GET /public-apis/{api-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-id
    Required*
    string

    API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document by name and version

Get the API document by name and version

GET /public-apis/{api-name}/{api-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document

Get the API wsdl document

GET /public-apis/{api-id}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • api-id
    Required*
    string

    API name

Query Parameters

  • endpoint
    string

    endpoint

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document by name and version

Get the API wsdl document by name and version

GET /public-apis/{api-name}/{api-version}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Query Parameters

  • endpoint
    string

    endpoint

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all Product objects in all collections

List all Product objects in all collections

GET /products

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Product objects

List the Product objects

GET /products/{product-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-name
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ProductList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by id

Get the Product object by id

GET /products/{product-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-id
    Required*
    string

    Product name

Query Parameters

  • fields
    string

    field name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product object by name and version

Get the Product object by name and version

GET /products/{product-name}/{product-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Query Parameters

  • fields
    string

    field name

Response

Response Body

Product

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document

Get the Product document

GET /products/{product-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-id
    Required*
    string

    Product name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Product document by name and version

Get the Product document by name and version

GET /products/{product-name}/{product-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • product-name
    Required*
    string

    Product name

  • product-version
    Required*
    string

    Product version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List all API objects in all collections

List all API objects in all collections

GET /apis

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the API objects

List the API objects

GET /apis/{api-name}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-name
    Required*
    string

    API name

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

APIList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by id

Get the API object by id

GET /apis/{api-id}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-id
    Required*
    string

    API name

Query Parameters

  • fields
    string

    field name

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API object by name and version

Get the API object by name and version

GET /apis/{api-name}/{api-version}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Query Parameters

  • fields
    string

    field name

Response

Response Body

API

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document

Get the API document

GET /apis/{api-id}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-id
    Required*
    string

    API name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API document by name and version

Get the API document by name and version

GET /apis/{api-name}/{api-version}/document

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document

Get the API wsdl document

GET /apis/{api-id}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • api-id
    Required*
    string

    API name

Query Parameters

  • endpoint
    string

    endpoint

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the API wsdl document by name and version

Get the API wsdl document by name and version

GET /apis/{api-name}/{api-version}/wsdl

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml,application/wsdl,application/zip]

Path Parameters

  • api-name
    Required*
    string

    API name

  • api-version
    Required*
    string

    API version name

Query Parameters

  • endpoint
    string

    endpoint

Response

Response Body

object

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Application object

Create a Application object

POST /orgs/{org}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

App

Response

Response Body

App

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application objects

List the Application objects

GET /orgs/{org}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AppList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Application objects

Clear the Application objects

DELETE /orgs/{org}/apps

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    string

    confirm clear

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Application object by name or id

Get the Application object by name or id

GET /apps/{org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

App

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Application object by name or id

Update the Application object by name or id

PATCH /apps/{org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

App

Response

Response Body

App

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Application object by name or id

Delete the Application object by name or id

DELETE /apps/{org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Response

Response Body

App

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application Type objects

List the Application Type objects

GET /application-types

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ApplicationTypeList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Application Type object by name or id

Get the Application Type object by name or id

GET /application-types/{application-type}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • application-type
    Required*
    string

    Application Type name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

ApplicationType

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Application Credential object

Create a Application Credential object

POST /apps/{org}/{app}/credentials

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application Credential objects

List the Application Credential objects

GET /apps/{org}/{app}/credentials

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

CredentialList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Application Credential objects

Clear the Application Credential objects

DELETE /apps/{org}/{app}/credentials

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • confirm
    string

    confirm clear

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Application Credential object by name or id

Get the Application Credential object by name or id

GET /apps/{org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Application Credential object by name or id

Update the Application Credential object by name or id

PATCH /apps/{org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Application Credential object by name or id

Delete the Application Credential object by name or id

DELETE /apps/{org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset the client id and client secret

Reset the client id and client secret

POST /apps/{org}/{app}/credentials/{credential}/reset

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset the client secret

Reset the client secret

POST /apps/{org}/{app}/credentials/{credential}/reset-client-secret

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Verify the client secret

Verify the client secret

POST /apps/{org}/{app}/credentials/{credential}/verify-client-secret

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Subscription object

Create a Subscription object

POST /apps/{org}/{app}/subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

Subscription

Response

Response Body

Subscription

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Subscription objects

List the Subscription objects

GET /apps/{org}/{app}/subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

SubscriptionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Subscription objects

Clear the Subscription objects

DELETE /apps/{org}/{app}/subscriptions

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • confirm
    string

    confirm clear

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Subscription object by name or id

Get the Subscription object by name or id

GET /apps/{org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Subscription

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Subscription object by name or id

Update the Subscription object by name or id

PATCH /apps/{org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Request Body

Subscription

Response

Response Body

Subscription

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Subscription object by name or id

Delete the Subscription object by name or id

DELETE /apps/{org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Response

Response Body

Subscription

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Application object

Create a Application object

POST /orgs/{org}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

App

Response

Response Body

App

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application objects

List the Application objects

GET /orgs/{org}/apps

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

AppList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Application objects

Clear the Application objects

DELETE /orgs/{org}/apps

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • confirm
    string

    confirm clear

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Application object by name or id

Get the Application object by name or id

GET /apps/{org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

App

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Application object by name or id

Update the Application object by name or id

PATCH /apps/{org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

App

Response

Response Body

App

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Application object by name or id

Delete the Application object by name or id

DELETE /apps/{org}/{app}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Response

Response Body

App

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application Type objects

List the Application Type objects

GET /application-types

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

ApplicationTypeList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Application Type object by name or id

Get the Application Type object by name or id

GET /application-types/{application-type}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • application-type
    Required*
    string

    Application Type name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

ApplicationType

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Application Credential object

Create a Application Credential object

POST /apps/{org}/{app}/credentials

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Application Credential objects

List the Application Credential objects

GET /apps/{org}/{app}/credentials

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

CredentialList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Application Credential objects

Clear the Application Credential objects

DELETE /apps/{org}/{app}/credentials

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • confirm
    string

    confirm clear

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Application Credential object by name or id

Get the Application Credential object by name or id

GET /apps/{org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Application Credential object by name or id

Update the Application Credential object by name or id

PATCH /apps/{org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Application Credential object by name or id

Delete the Application Credential object by name or id

DELETE /apps/{org}/{app}/credentials/{credential}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset the client id and client secret

Reset the client id and client secret

POST /apps/{org}/{app}/credentials/{credential}/reset

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Reset the client secret

Reset the client secret

POST /apps/{org}/{app}/credentials/{credential}/reset-client-secret

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Response

Response Body

Credential

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Verify the client secret

Verify the client secret

POST /apps/{org}/{app}/credentials/{credential}/verify-client-secret

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • credential
    Required*
    string

    Application Credential name or id

Request Body

Credential

Response

Response Body

Credential

Status Code

  • 201

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Subscription object

Create a Subscription object

POST /apps/{org}/{app}/subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Request Body

Subscription

Response

Response Body

Subscription

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Subscription objects

List the Subscription objects

GET /apps/{org}/{app}/subscriptions

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

SubscriptionList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Clear the Subscription objects

Clear the Subscription objects

DELETE /apps/{org}/{app}/subscriptions

Request

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

Query Parameters

  • confirm
    string

    confirm clear

Response

Status Code

  • 204

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Subscription object by name or id

Get the Subscription object by name or id

GET /apps/{org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Subscription

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Subscription object by name or id

Update the Subscription object by name or id

PATCH /apps/{org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Request Body

Subscription

Response

Response Body

Subscription

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Delete the Subscription object by name or id

Delete the Subscription object by name or id

DELETE /apps/{org}/{app}/subscriptions/{subscription}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • app
    Required*
    string

    Application name or id

  • subscription
    Required*
    string

    Subscription name or id

Response

Response Body

Subscription

Status Code

  • 200

    Successful delete

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Billing objects

List the Billing objects

GET /orgs/{org}/billings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

BillingList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Billing object by name or id

Get the Billing object by name or id

GET /orgs/{org}/billings/{billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Billing

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Billing objects

List the Billing objects

GET /orgs/{org}/billings

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

BillingList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Billing object by name or id

Get the Billing object by name or id

GET /orgs/{org}/billings/{billing}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • billing
    Required*
    string

    Billing name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

Billing

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Create a Payment Method object

Create a Payment Method object

POST /orgs/{org}/payment-methods

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Request Body

PaymentMethod

Response

Response Body

PaymentMethod

Status Code

  • 201

    Successful create

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

List the Payment Method objects

List the Payment Method objects

GET /orgs/{org}/payment-methods

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

Query Parameters

  • fields
    string

    field name

  • offset
    integer

    Offset item number from list to begin return

  • limit
    integer

    Maximum number of items to return

Response

Response Body

PaymentMethodList

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Get the Payment Method object by name or id

Get the Payment Method object by name or id

GET /orgs/{org}/payment-methods/{payment-method}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • payment-method
    Required*
    string

    Payment Method name or id

Query Parameters

  • fields
    string

    field name

Response

Response Body

PaymentMethod

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.

Update the Payment Method object by name or id

Update the Payment Method object by name or id

PATCH /orgs/{org}/payment-methods/{payment-method}

Request

Custom Headers

  • Accept
    string

    Allowable values: [application/json,application/yaml]

  • Content-Type
    string

    Allowable values: [application/json,application/yaml]

Path Parameters

  • org
    Required*
    string

    Organization name or id

  • payment-method
    Required*
    string

    Payment Method name or id

Request Body

PaymentMethod

Response

Response Body

PaymentMethod

Status Code

  • 200

    Success

  • default

    Unexpected error

No Sample Response

This method does not specify any sample responses.