Update Issuer

PUT 
https://platform.nativeframe.com/auth/v1/issuers/:iss

Generate JWT

Request

Path Parameters

iss stringrequired

Issuer ID

application/json

Body

required

iss stringrequired

Issuer of the JWT

project

object

required

id stringrequired
JWKsURL string

URL to the JWKs public keys, if no URL is provided you must include 'keys', if both are provided the keys fetched from the URL are merged with the supplied keys

aud string[]

An array of audiences that are valid for this issuer, an empty array is allowed

roles string[]

An array of roles that are allowed for this issuer, an empty permmits all roles

prm uint64

An uint64 bitmask representing the permissions valid for this issuser, an empty value permits all permissions

internal boolean

Indicates that this issuer is an internal issuer (NOTE: this field can not be set via the API)

static boolean

Indicates that this issuer was added via a configuration, (NOTE: this field can not set via the API)

keys array

JWK public keys used for this issuer, an emtpy array is allowed if a JWKsURL is also provided

Responses

200

Issuer

application/json

Schema

Schema

iss stringrequired

Issuer of the JWT

project

object

required

id stringrequired
JWKsURL string

URL to the JWKs public keys, if no URL is provided you must include 'keys', if both are provided the keys fetched from the URL are merged with the supplied keys

aud string[]

An array of audiences that are valid for this issuer, an empty array is allowed

roles string[]

An array of roles that are allowed for this issuer, an empty permmits all roles

prm uint64

An uint64 bitmask representing the permissions valid for this issuser, an empty value permits all permissions

internal boolean

Indicates that this issuer is an internal issuer (NOTE: this field can not be set via the API)

static boolean

Indicates that this issuer was added via a configuration, (NOTE: this field can not set via the API)

keys array

JWK public keys used for this issuer, an emtpy array is allowed if a JWKsURL is also provided

Example (from schema)

{
  "iss": "string",
  "project": {
    "id": "string"
  },
  "JWKsURL": "string",
  "aud": [
    "string"
  ],
  "roles": [
    "string"
  ],
  "prm": 0,
  "internal": true,
  "static": true,
  "keys": [
    null
  ]
}

400

Bad Request

application/json

Schema

Schema

message stringrequired

Error message for the end user

errorCode string

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

name stringrequired

reason stringrequired

errorCode string

]

internal string

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

401

JWT

application/json

Schema

Schema

message stringrequired

Error message for the end user

errorCode string

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

name stringrequired

reason stringrequired

errorCode string

]

internal string

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

403

Forbidden

application/json

Schema

Schema

message stringrequired

Error message for the end user

errorCode string

Code that can be set that supplies a specific reason for why a request failed

invalidFields

object[]

Specific error scoped to a field

Array [

name stringrequired

reason stringrequired

errorCode string

]

internal string

Internal user only

Example (from schema)

{
  "message": "string",
  "errorCode": "string",
  "invalidFields": [
    {
      "name": "string",
      "reason": "string",
      "errorCode": "string"
    }
  ],
  "internal": "string"
}

Authorization: http

name: JWTtype: httpscopes: roles:service-account,internal-account,aud:service-account,internal-accountscheme: bearerbearerFormat: JWTdescription: Bearer Token authentication for applications

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://platform.nativeframe.com/auth/v1/issuers/:iss");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var content = new StringContent("{\n  \"iss\": \"string\",\n  \"project\": {\n    \"id\": \"string\"\n  },\n  \"JWKsURL\": \"string\",\n  \"aud\": [\n    \"string\"\n  ],\n  \"roles\": [\n    \"string\"\n  ],\n  \"prm\": 0,\n  \"internal\": true,\n  \"static\": true,\n  \"keys\": [\n    null\n  ]\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://platform.nativeframe.com

Auth

Bearer Token

Parameters

iss — pathrequired

Body required

{
  "iss": "string",
  "project": {
    "id": "string"
  },
  "JWKsURL": "string",
  "aud": [
    "string"
  ],
  "roles": [
    "string"
  ],
  "prm": 0,
  "internal": true,
  "static": true,
  "keys": [
    null
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!