Clients

Download OpenAPI specification:Download

Manage your clients

Create client

Create a new client

SecurityHTTP: bearer

Request

Request Body schema: application/json

name required	string Name of the client
description	string Short description of the client
redirect_uris required	Array of strings List of URI approved for redirects for your client
client_type	string Default: "web" Client type Enum: "web" "native"
response_types	Array of strings Default: ["code","id_token"] Items Enum: "code" "id_token"
token_endpoint_auth_method	string Default: "client_secret_basic" Which token endpoint authentication method to allow for the token endpoint. Unauthorized requests are only allowed for native clients that will perform a centralized login flow (via the Authentication Hub) with PKCE. Enum: "client_secret_basic" "none"
resources	Array of strings List of resources IDs associated with this client
	object Configuration for an OAuth Device Authorization Flow
	object CIBA authorization flow configuration

Responses

201

400

409

post/v1/clients

Request samples

application/json

{"name": "My Client",
"description": "string",
"redirect_uris": ["https://www.example.com/login"
],
"client_type": "web",
"response_types": ["code"
],
"token_endpoint_auth_method": "client_secret_basic",
"resources": ["string"
],
"device_authorization": {"enabled": false,
"approval_uri": "https://www.example.com/device/approval",
"success_uri": "https://www.example.com/device/complete",
"input_uri": "https://www.example.com/device/start"
},
"ciba_authorization": {"enabled": false,
"login_uri": "https://www.example.com/ciba/login"
}
}

Response samples

application/json

{"result": {"app_id": "string",
"tenant_id": "string",
"client_id": "string",
"client_secret": "string",
"name": "string",
"description": "string",
"redirect_uris": ["string"
],
"client_type": "web",
"response_types": ["code"
],
"token_endpoint_auth_method": "client_secret_basic",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"resources": ["string"
],
"device_authorization": {"enabled": false,
"approval_uri": "https://www.example.com/device/approval",
"success_uri": "https://www.example.com/device/complete",
"input_uri": "https://www.example.com/device/start"
},
"ciba_authorization": {"enabled": false,
"login_uri": "https://www.example.com/ciba/login"
}
}
}

Get all clients

Retrieves a list of all clients

SecurityHTTP: bearer

Responses

200

400

get/v1/clients

Request samples

curl -i -X GET \
  https://api.transmitsecurity.io/cis/v1/clients \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

application/json

{"result": [{"app_id": "string",
"tenant_id": "string",
"client_id": "string",
"client_secret": "string",
"name": "string",
"description": "string",
"redirect_uris": ["string"
],
"client_type": "web",
"response_types": ["code"
],
"token_endpoint_auth_method": "client_secret_basic",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"resources": ["string"
],
"device_authorization": {"enabled": false,
"approval_uri": "https://www.example.com/device/approval",
"success_uri": "https://www.example.com/device/complete",
"input_uri": "https://www.example.com/device/start"
},
"ciba_authorization": {"enabled": false,
"login_uri": "https://www.example.com/ciba/login"
}
}
]
}

Delete all clients

SecurityHTTP: bearer

Responses

204

400

404

delete/v1/clients

Request samples

curl -i -X DELETE \
  https://api.transmitsecurity.io/cis/v1/clients \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

application/json

{"message": "Bad request",
"error_code": 400
}

Get client by ID

Retrieves a client by client ID

SecurityHTTP: bearer

Request

path Parameters

clientId

required

string

ID of the client to retrieve

Responses

200

400

404

get/v1/clients/{clientId}

Request samples

curl -i -X GET \
  'https://api.transmitsecurity.io/cis/v1/clients/{clientId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

application/json

{"result": {"app_id": "string",
"tenant_id": "string",
"client_id": "string",
"client_secret": "string",
"name": "string",
"description": "string",
"redirect_uris": ["string"
],
"client_type": "web",
"response_types": ["code"
],
"token_endpoint_auth_method": "client_secret_basic",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"resources": ["string"
],
"device_authorization": {"enabled": false,
"approval_uri": "https://www.example.com/device/approval",
"success_uri": "https://www.example.com/device/complete",
"input_uri": "https://www.example.com/device/start"
},
"ciba_authorization": {"enabled": false,
"login_uri": "https://www.example.com/ciba/login"
}
}
}

Update client

Update a client

SecurityHTTP: bearer

Request

path Parameters

clientId

required

string

ID of the client to update

Request Body schema: application/json

name	string Name of the client
description	string Short description of the client
redirect_uris	Array of strings List of URI approved for redirects for your client
client_type	string Default: "web" Client type Enum: "web" "native"
response_types	Array of strings Default: ["code","id_token"] Items Enum: "code" "id_token"
token_endpoint_auth_method	string Default: "client_secret_basic" Which token endpoint authentication method to allow for the token endpoint. Unauthorized requests are only allowed for native clients that will perform a centralized login flow (via the Authentication Hub) with PKCE. Enum: "client_secret_basic" "none"
resources	Array of strings List of resources IDs associated with this client
	object Configuration for an OAuth Device Authorization Flow
	object CIBA authorization flow configuration

Responses

200

400

404

put/v1/clients/{clientId}

Request samples

application/json

{"name": "My Client",
"description": "string",
"redirect_uris": ["https://www.example.com/login"
],
"client_type": "web",
"response_types": ["code"
],
"token_endpoint_auth_method": "client_secret_basic",
"resources": ["string"
],
"device_authorization": {"enabled": false,
"approval_uri": "https://www.example.com/device/approval",
"success_uri": "https://www.example.com/device/complete",
"input_uri": "https://www.example.com/device/start"
},
"ciba_authorization": {"enabled": false,
"login_uri": "https://www.example.com/ciba/login"
}
}

Response samples

application/json

{"result": {"app_id": "string",
"tenant_id": "string",
"client_id": "string",
"client_secret": "string",
"name": "string",
"description": "string",
"redirect_uris": ["string"
],
"client_type": "web",
"response_types": ["code"
],
"token_endpoint_auth_method": "client_secret_basic",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"resources": ["string"
],
"device_authorization": {"enabled": false,
"approval_uri": "https://www.example.com/device/approval",
"success_uri": "https://www.example.com/device/complete",
"input_uri": "https://www.example.com/device/start"
},
"ciba_authorization": {"enabled": false,
"login_uri": "https://www.example.com/ciba/login"
}
}
}

Delete client

Delete a client

SecurityHTTP: bearer

Request

path Parameters

clientId

required

string

ID of the client to delete

Responses

204

400

404

delete/v1/clients/{clientId}

Request samples

curl -i -X DELETE \
  'https://api.transmitsecurity.io/cis/v1/clients/{clientId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

application/json

{"message": "Bad request",
"error_code": 400
}

Update client resources

Update the list of resources that a client is allowed to explicitly request access to

SecurityHTTP: bearer

Request

path Parameters

clientId

required

string

Request Body schema: application/json

resource_ids

required

Array of strings

List of resources this application is allowed to explicitly request access to

Responses

200

put/v1/clients/{clientId}/resources

Request samples

application/json

{"resource_ids": ["string"
]
}

Response samples

application/json

{"result": {"app_id": "string",
"tenant_id": "string",
"client_id": "string",
"client_secret": "string",
"name": "string",
"description": "string",
"redirect_uris": ["string"
],
"client_type": "web",
"response_types": ["code"
],
"token_endpoint_auth_method": "client_secret_basic",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"resources": ["string"
],
"device_authorization": {"enabled": false,
"approval_uri": "https://www.example.com/device/approval",
"success_uri": "https://www.example.com/device/complete",
"input_uri": "https://www.example.com/device/start"
},
"ciba_authorization": {"enabled": false,
"login_uri": "https://www.example.com/ciba/login"
}
}
}