Intraplatform 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 intraplatform credentials for the authenticated user.

These credentials have a special decryption route (POST /api/v1/intraplatform_credentials/[intraplatform_credential_id]/decrypt) to request for password of a certain credential.

No batch decryption is allowed as it is computationally costly for the server. However, this rule may change in the future if necessary security steps has been conceived.

GET/api/v1/intraplatform_credentials

Allows the client to have a list of intraplatform credentials existing for the current user. However, this does not show the password for each credentials. To see, the client must request again through the decryption route.

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"
		}
	]
}

GET/api/v1/intraplatform_credentials/[intraplatform_credential_id]

Allows the client to request a specific intraplatform credential info. However, this does not show the password. To see, the client must request again through the decryption route.

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: 

    {
	"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"
	}
}

POST/api/v1/intraplatform_credentials/[intraplatform_credential_id]/decrypt

Allows the client to request the decrypted password of a specified credential given that the password of the current authenticated user is correct.

Request Info

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

{
	"user": {
		"password": "string"
	}
}

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: 

    {
	"intraplatform_credential": {
		"password": "string"
	}
}

POST/api/v1/intraplatform_credentials

Allows the client to create intraplatform 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: 

{
	"intraplatform_credential": {
		"platform_id": "number",
		"identifier": "string",
		"password": "string",
		"password_confirmation": "string",
		"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"
	}
}

PUT/api/v1/intraplatform_credentials/[intraplatform_credential_id]

Allows the client to update intraplatform credential info.

Request Info

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

{
	"intraplatform_credential": {
		"identifier": "string",
		"password": "?string",
		"password_confirmation": "?string",
		"extras": "object"
	}
}

Defined Responses

  • Route may return a status code of 204.

DELETE/api/v1/intraplatform_credentials/[intraplatform_credential_id]

Allows the client to delete intraplatform 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.