Auth (1)

Download OpenAPI specification:Download

Generated by protoc-gen-openapi

Authentication

MicroAPIToken

Micro API token

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

Accounts.ChangeSecret(ChangeSecretRequest)

Authorizations:

MicroAPIToken

header Parameters

Micro-Namespace

required

string

Request Body schema: application/json

AccountsChangeSecretRequest

id	string
newSecret	string
oldSecret	string
	object

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"newSecret": "string",
"oldSecret": "string",
"options": {"namespace": "string"
}
}

Response samples

200
default

Content type

application/json

{ }

Accounts.Delete(DeleteAccountRequest)

Authorizations:

MicroAPIToken

header Parameters

Micro-Namespace

required

string

Request Body schema: application/json

AccountsDeleteRequest

id	string
	object

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"options": {"namespace": "string"
}
}

Response samples

200
default

Content type

application/json

{ }

Accounts.List(ListAccountsRequest)

Authorizations:

MicroAPIToken

header Parameters

Micro-Namespace

required

string

Request Body schema: application/json

AccountsListRequest

object

Responses

Request samples

Payload

Content type

application/json

{"options": {"namespace": "string"
}
}

Response samples

200
default

Content type

application/json

{"accounts": {"id": "string",
"issuer": "string",
"metadata": {"property1": {"key": "string",
"value": "string"
},
"property2": {"key": "string",
"value": "string"
}
},
"name": "string",
"scopes": ["string"
],
"secret": "string",
"type": "string"
}
}

Auth.Generate(GenerateRequest)

Authorizations:

MicroAPIToken

header Parameters

Micro-Namespace

required

string

Request Body schema: application/json

AuthGenerateRequest

id	string
	object
name	string
	object
provider	string
scopes	Array of strings
secret	string
type	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"metadata": {"property1": {"key": "string",
"value": "string"
},
"property2": {"key": "string",
"value": "string"
}
},
"name": "string",
"options": {"namespace": "string"
},
"provider": "string",
"scopes": ["string"
],
"secret": "string",
"type": "string"
}

Response samples

200
default

Content type

application/json

{"account": {"id": "string",
"issuer": "string",
"metadata": {"property1": {"key": "string",
"value": "string"
},
"property2": {"key": "string",
"value": "string"
}
},
"name": "string",
"scopes": ["string"
],
"secret": "string",
"type": "string"
}
}

Auth.Inspect(InspectRequest)

Authorizations:

MicroAPIToken

header Parameters

Micro-Namespace

required

string

Request Body schema: application/json

AuthInspectRequest

	object
token	string

Responses

Request samples

Payload

Content type

application/json

{"options": {"namespace": "string"
},
"token": "string"
}

Response samples

200
default

Content type

application/json

{"account": {"id": "string",
"issuer": "string",
"metadata": {"property1": {"key": "string",
"value": "string"
},
"property2": {"key": "string",
"value": "string"
}
},
"name": "string",
"scopes": ["string"
],
"secret": "string",
"type": "string"
}
}

Auth.Token(TokenRequest)

Authorizations:

MicroAPIToken

header Parameters

Micro-Namespace

required

string

Request Body schema: application/json

AuthTokenRequest

id	string
	object
refreshToken	string
secret	string
tokenExpiry	number <int64>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"options": {"namespace": "string"
},
"refreshToken": "string",
"secret": "string",
"tokenExpiry": 0
}

Response samples

200
default

Content type

application/json

{"token": {"accessToken": "string",
"created": 0,
"expiry": 0,
"refreshToken": "string"
}
}

Rules.Create(CreateRequest)

Authorizations:

MicroAPIToken

header Parameters

Micro-Namespace

required

string

Request Body schema: application/json

RulesCreateRequest

	object
	object

Responses

Request samples

Payload

Content type

application/json

{"options": {"namespace": "string"
},
"rule": {"access": "string",
"id": "string",
"priority": 0,
"resource": {"endpoint": "string",
"name": "string",
"type": "string"
},
"scope": "string"
}
}

Response samples

200
default

Content type

application/json

{ }

Rules.Delete(DeleteRequest)

Authorizations:

MicroAPIToken

header Parameters

Micro-Namespace

required

string

Request Body schema: application/json

RulesDeleteRequest

id	string
	object

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"options": {"namespace": "string"
}
}

Response samples

200
default

Content type

application/json

{ }

Rules.List(ListRequest)

Authorizations:

MicroAPIToken

header Parameters

Micro-Namespace

required

string

Request Body schema: application/json

RulesListRequest

object

Responses

Request samples

Payload

Content type

application/json

{"options": {"namespace": "string"
}
}

Response samples

200
default

Content type

application/json

{"rules": {"access": "string",
"id": "string",
"priority": 0,
"resource": {"endpoint": "string",
"name": "string",
"type": "string"
},
"scope": "string"
}
}