List Issuers

cURL

curl --request GET \
  --url https://api.plumaa.id/rest/v1/issuers \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "info": {
    "id": "<string>",
    "count": "<unknown>",
    "pages": "<unknown>",
    "next": "<unknown>",
    "prev": "<unknown>"
  },
  "results": [
    {
      "id": "<unknown>",
      "hash": "<unknown>",
      "commonName": "<string>",
      "publicKey": {
        "exponent": "<unknown>",
        "modulus": "<unknown>"
      },
      "certificatePem": "<string>",
      "createdAt": "<unknown>",
      "updatedAt": "<unknown>",
      "RFC": "<string>",
      "organization": "<string>",
      "organizationalUnitName": "<string>",
      "emailAddress": "<unknown>",
      "streetAddress": "<string>",
      "postalCode": 123,
      "country": "<unknown>",
      "stateOrProvinceName": "<string>",
      "localityName": "<string>"
    }
  ]
}

GET

issuers

cURL

curl --request GET \
  --url https://api.plumaa.id/rest/v1/issuers \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "info": {
    "id": "<string>",
    "count": "<unknown>",
    "pages": "<unknown>",
    "next": "<unknown>",
    "prev": "<unknown>"
  },
  "results": [
    {
      "id": "<unknown>",
      "hash": "<unknown>",
      "commonName": "<string>",
      "publicKey": {
        "exponent": "<unknown>",
        "modulus": "<unknown>"
      },
      "certificatePem": "<string>",
      "createdAt": "<unknown>",
      "updatedAt": "<unknown>",
      "RFC": "<string>",
      "organization": "<string>",
      "organizationalUnitName": "<string>",
      "emailAddress": "<unknown>",
      "streetAddress": "<string>",
      "postalCode": 123,
      "country": "<unknown>",
      "stateOrProvinceName": "<string>",
      "localityName": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

_id

object

ObjectID matching arguments.

Show child attributes

_id.exists

boolean

If provided, it will apply an $exists filter. See https://www.mongodb.com/docs/manual/reference/operator/query/exists/#-exists

_id.eq

any

If provided, it will apply an $eq filter. See https://www.mongodb.com/docs/manual/reference/operator/query/eq/#op._S_eq

_id.ne

any

If provided, it will apply a $ne filter. See https://www.mongodb.com/docs/manual/reference/operator/query/ne/#op._S_ne

_id.in

any[]

If provided, it will apply an $in filter. See https://www.mongodb.com/docs/manual/reference/operator/query/in/#op._S_in

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

_id.nin

any[]

If provided, it will apply a $nin filter. See https://www.mongodb.com/docs/manual/reference/operator/query/nin/#op._S_nin

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

object

Search arguments for Issuers query.

Show child attributes

search.commonName

string

Matches a similar string in the commonName field.

search.organization

string

Matches a similar string in the organization field.

search.organizationalUnitName

string

Matches a similar string in the organizationalUnitName field.

search.emailAddress

string

Matches a similar string in the emailAddress field.

search.streetAddress

string

Matches a similar string in the streetAddress field.

search.stateOrProvinceName

string

Matches a similar string in the stateOrProvinceName field.

search.localityName

string

Matches a similar string in the localityName field.

postalCode

object

NonNegativeInt matching arguments.

Show child attributes

postalCode.exists

boolean

If provided, it will apply an $exists filter. See https://www.mongodb.com/docs/manual/reference/operator/query/exists/#-exists

postalCode.eq

any

If provided, it will apply an $eq filter. See https://www.mongodb.com/docs/manual/reference/operator/query/eq/#op._S_eq

postalCode.ne

any

If provided, it will apply a $ne filter. See https://www.mongodb.com/docs/manual/reference/operator/query/ne/#op._S_ne

postalCode.in

any[]

If provided, it will apply an $in filter. See https://www.mongodb.com/docs/manual/reference/operator/query/in/#op._S_in

Integers that will have a value of 0 or more.

postalCode.nin

any[]

If provided, it will apply a $nin filter. See https://www.mongodb.com/docs/manual/reference/operator/query/nin/#op._S_nin

Integers that will have a value of 0 or more.

country

object

ID matching arguments.

Show child attributes

country.exists

boolean

If provided, it will apply an $exists filter. See https://www.mongodb.com/docs/manual/reference/operator/query/exists/#-exists

country.eq

string

If provided, it will apply an $eq filter. See https://www.mongodb.com/docs/manual/reference/operator/query/eq/#op._S_eq

country.ne

string

If provided, it will apply a $ne filter. See https://www.mongodb.com/docs/manual/reference/operator/query/ne/#op._S_ne

country.in

string[]

If provided, it will apply an $in filter. See https://www.mongodb.com/docs/manual/reference/operator/query/in/#op._S_in

country.nin

string[]

If provided, it will apply a $nin filter. See https://www.mongodb.com/docs/manual/reference/operator/query/nin/#op._S_nin

createdAt

object

Date range arguments.

Show child attributes

createdAt.exists

boolean

If provided, it will apply an $exists filter.

createdAt.lte

any

Lower than or equal to.

createdAt.gte

any

Greater than or equal to.

updatedAt

object

Date range arguments.

Show child attributes

updatedAt.exists

boolean

If provided, it will apply an $exists filter.

updatedAt.lte

any

Lower than or equal to.

updatedAt.gte

any

Greater than or equal to.

sort

object

Sort arguments for ApiCalls query.

Show child attributes

sort.field

enum<string>

required

The field to sort results by.

Available options:

createdAt,

updatedAt

sort.order

enum<string>

required

The order to sort by.

Available options:

asc,

desc

pagination

object

Pagination arguments.

Show child attributes

pagination.page

any

required

Page number. Starts at 1.

pagination.size

any

required

Page size.

Response

200 - application/json

Results of an Issuers query.

string

required

info

object

required

Pagination info.

Show child attributes

info.id

string

required

info.count

any

Total number of items

info.pages

any

Total amount of pages

info.next

any

info.prev

any

results

object[]

required

List of Issuers.

Show child attributes

results.id

any

required

A field whose value conforms with the standard mongodb object ID as described here: https://docs.mongodb.com/manual/reference/method/ObjectId/#ObjectId. Example: 5e5677d71bdc2ae76344968c

results.hash

any

required

The hash of the issuer's certificate.

results.commonName

string

required

The name of the certificate authority.

results.publicKey

object

required

The issuer's certificate public key. This is the public key that identifies messages the issuer has signed a certificate for a subject.

Show child attributes

results.publicKey.exponent

any

required

The public key's modulus, as a hexadecimal string.

results.publicKey.modulus

any

required

The public key's exponent, as a hexadecimal string.

results.certificatePem

string

required

AWS S3 URI path to the issuer certificate's PEM data.

results.createdAt

any

required

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

results.updatedAt

any

required

results.RFC

string

RFC of the issuer.

results.organization

string

Name of the organization or company. "Razón Social" in Spanish.

results.organizationalUnitName

string

Name of the unit within the organization. "Unidad Organizacional" in Spanish.

results.emailAddress

any

Email address of the issuer.

results.streetAddress

string

Street address of the issuer.

results.postalCode

integer<int32>

Postal code of the issuer.

results.country

any

"Country" of the issuer.

results.stateOrProvinceName

string

"Entidad Federativa" of the issuer.

results.localityName

string

"Municipio/Delegación" of the issuer.

Issuer Definition Get an Issuer

⌘I

Introduction

Certificate

Issuer

Organization

Signature Request Invite

Signature Request

Subject

Witness

Wallet

Endorsable

Endorse Event

API Key

Organization Link

Organization Member

Timeseries

Price Oracle

Other

Authorizations

Query Parameters

Response