Interplatform Credential Routes

Part of REST API Documentation (v0.1.0) last public on August 5, 2023 at 12:00 AM UTC. You may see previous version(s) of the zone.

The routes listed in this page allows the client to perform CRUD operations on interplatform credentials for the authenticated user.

Note that only the extra data can be updated in this kind of resource.

`GET/api/v1/interplatform_credentials`

Allows the client to have a list of interplatform credentials existing for the current user.

Request Info

There are no inputs needed to invoke the route.

Defined Responses

Route may return a status code of 200.

It returns a response having application/json as its content type with a schema of:

{
	"platforms": [
		{
			"id": "number",
			"user_id": "number",
			"name": "string",
			"address": "string",
			"created_at": "string",
			"updated_at": "string"
		}
	],
	"intraplatform_credentials": [
		{
			"id": "number",
			"platform_id": "number",
			"identifier": "string",
			"extras": "object",
			"created_at": "string",
			"updated_at": "string"
		}
	],
	"interplatform_credentials": [
		{
			"id": "number",
			"platform_id": "number",
			"intraplatform_credential_id": "number",
			"extras": "object",
			"created_at": "string",
			"updated_at": "string"
		}
	]
}

`GET/api/v1/interplatform_credentials/[interplatform_credential_id]`

Allows the client to request a specific interplatform credential info.

Request Info

There are no inputs needed to invoke the route.

Defined Responses

Route may return a status code of 200.

It returns a response having application/json as its content type with a schema of:

{
	"platforms": [
		{
			"id": "number",
			"user_id": "number",
			"name": "string",
			"address": "string",
			"created_at": "string",
			"updated_at": "string"
		}
	],
	"intraplatform_credential": {
		"id": "number",
		"platform_id": "number",
		"identifier": "string",
		"extras": "object",
		"created_at": "string",
		"updated_at": "string"
	},
	"interplatform_credential": {
		"id": "number",
		"platform_id": "number",
		"intraplatform_credential_id": "number",
		"extras": "object",
		"created_at": "string",
		"updated_at": "string"
	}
}

`POST/api/v1/interplatform_credentials`

Allows the client to create interplatform credential info. Note that servers must encrypt the password of the submitted credential.

Request Info

It requires an input having application/json with a schema of:

{
	"interplatform_credential": {
		"platform_id": "number",
		"intraplatform_credential_id": "number",
		"extras": "object"
	}
}

Defined Responses

Route may return a status code of 201.

It returns a response having application/json as its content type with a schema of:

{
	"platform": {
		"id": "number",
		"user_id": "number",
		"name": "string",
		"address": "string",
		"created_at": "string",
		"updated_at": "string"
	},
	"intraplatform_credential": {
		"id": "number",
		"platform_id": "number",
		"identifier": "string",
		"extras": "object",
		"created_at": "string",
		"updated_at": "string"
	},
	"interplatform_credential": {
		"id": "number",
		"platform_id": "number",
		"intraplatform_credential_id": "number",
		"extras": "object",
		"created_at": "string",
		"updated_at": "string"
	}
}

`PUT/api/v1/interplatform_credentials/[interplatform_credential_id]`

Allows the client to update interplatform credential info.

Request Info

It requires an input having application/json with a schema of:

{
	"interplatform_credential": {
		"extras": "object"
	}
}

Defined Responses

Route may return a status code of 204.

`DELETE/api/v1/interplatform_credentials/[interplatform_credential_id]`

Allows the client to delete interplatform credential info.

Request Info

There are no inputs needed to invoke the route.

Defined Responses

Route may return a status code of 204.

Previous versions

There are no previous versions yet. Check back in the future.