createClient
Create client
/v2/modules/{module}/setups/{setupId}/clients
Usage and SDK Samples
curl -X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
"http://localhost/v2/modules/{module}/setups/{setupId}/clients" \
-d '{
"notSentGrantType" : true,
"metadata" : [ {
"name" : "name",
"locale" : "locale",
"value" : "value"
}, {
"name" : "name",
"locale" : "locale",
"value" : "value"
} ],
"client_uri" : "client_uri",
"jwks" : {
"keys" : [ {
"private" : true,
"issueTime" : "2000-01-23T04:56:07.000+00:00",
"keyID" : "keyID",
"x509CertSHA256Thumbprint" : "{}",
"x509CertThumbprint" : "{}",
"keyRevocation" : {
"reason" : {
"value" : "value"
},
"revocationTime" : "2000-01-23T04:56:07.000+00:00"
},
"keyOperations" : [ "sign", "sign" ],
"x509CertChain" : [ null, null ],
"parsedX509CertChain" : [ {
"notAfter" : "2000-01-23T04:56:07.000+00:00",
"signature" : [ "signature", "signature" ],
"sigAlgParams" : [ "sigAlgParams", "sigAlgParams" ],
"subjectAlternativeNames" : [ [ "{}", "{}" ], [ "{}", "{}" ] ],
"publicKey" : {
"format" : "format",
"encoded" : [ "encoded", "encoded" ],
"algorithm" : "algorithm"
},
"type" : "type",
"notBefore" : "2000-01-23T04:56:07.000+00:00",
"sigAlgName" : "sigAlgName",
"nonCriticalExtensionOIDs" : [ "nonCriticalExtensionOIDs", "nonCriticalExtensionOIDs" ],
"keyUsage" : [ true, true ],
"issuerAlternativeNames" : [ [ "{}", "{}" ], [ "{}", "{}" ] ],
"basicConstraints" : 6,
"issuerX500Principal" : {
"name" : "name",
"encoded" : [ "encoded", "encoded" ]
},
"subjectDN" : {
"name" : "name"
},
"criticalExtensionOIDs" : [ "criticalExtensionOIDs", "criticalExtensionOIDs" ],
"serialNumber" : 0,
"issuerUniqueID" : [ true, true ],
"issuerDN" : {
"name" : "name"
},
"tbscertificate" : [ "tbscertificate", "tbscertificate" ],
"subjectX500Principal" : {
"name" : "name",
"encoded" : [ "encoded", "encoded" ]
},
"subjectUniqueID" : [ true, true ],
"version" : 1,
"sigAlgOID" : "sigAlgOID",
"extendedKeyUsage" : [ "extendedKeyUsage", "extendedKeyUsage" ],
"encoded" : [ "encoded", "encoded" ]
}, {
"notAfter" : "2000-01-23T04:56:07.000+00:00",
"signature" : [ "signature", "signature" ],
"sigAlgParams" : [ "sigAlgParams", "sigAlgParams" ],
"subjectAlternativeNames" : [ [ "{}", "{}" ], [ "{}", "{}" ] ],
"publicKey" : {
"format" : "format",
"encoded" : [ "encoded", "encoded" ],
"algorithm" : "algorithm"
},
"type" : "type",
"notBefore" : "2000-01-23T04:56:07.000+00:00",
"sigAlgName" : "sigAlgName",
"nonCriticalExtensionOIDs" : [ "nonCriticalExtensionOIDs", "nonCriticalExtensionOIDs" ],
"keyUsage" : [ true, true ],
"issuerAlternativeNames" : [ [ "{}", "{}" ], [ "{}", "{}" ] ],
"basicConstraints" : 6,
"issuerX500Principal" : {
"name" : "name",
"encoded" : [ "encoded", "encoded" ]
},
"subjectDN" : {
"name" : "name"
},
"criticalExtensionOIDs" : [ "criticalExtensionOIDs", "criticalExtensionOIDs" ],
"serialNumber" : 0,
"issuerUniqueID" : [ true, true ],
"issuerDN" : {
"name" : "name"
},
"tbscertificate" : [ "tbscertificate", "tbscertificate" ],
"subjectX500Principal" : {
"name" : "name",
"encoded" : [ "encoded", "encoded" ]
},
"subjectUniqueID" : [ true, true ],
"version" : 1,
"sigAlgOID" : "sigAlgOID",
"extendedKeyUsage" : [ "extendedKeyUsage", "extendedKeyUsage" ],
"encoded" : [ "encoded", "encoded" ]
} ],
"notBeforeTime" : "2000-01-23T04:56:07.000+00:00",
"x509CertURL" : "https://openapi-generator.tech",
"requiredParams" : {
"key" : "{}"
},
"expirationTime" : "2000-01-23T04:56:07.000+00:00",
"keyUse" : {
"value" : "value"
},
"keyStore" : {
"provider" : {
"key" : "provider"
},
"type" : "type"
},
"keyType" : {
"requirement" : "REQUIRED",
"value" : "value"
},
"algorithm" : {
"name" : "name",
"requirement" : "REQUIRED"
}
}, {
"private" : true,
"issueTime" : "2000-01-23T04:56:07.000+00:00",
"keyID" : "keyID",
"x509CertSHA256Thumbprint" : "{}",
"x509CertThumbprint" : "{}",
"keyRevocation" : {
"reason" : {
"value" : "value"
},
"revocationTime" : "2000-01-23T04:56:07.000+00:00"
},
"keyOperations" : [ "sign", "sign" ],
"x509CertChain" : [ null, null ],
"parsedX509CertChain" : [ {
"notAfter" : "2000-01-23T04:56:07.000+00:00",
"signature" : [ "signature", "signature" ],
"sigAlgParams" : [ "sigAlgParams", "sigAlgParams" ],
"subjectAlternativeNames" : [ [ "{}", "{}" ], [ "{}", "{}" ] ],
"publicKey" : {
"format" : "format",
"encoded" : [ "encoded", "encoded" ],
"algorithm" : "algorithm"
},
"type" : "type",
"notBefore" : "2000-01-23T04:56:07.000+00:00",
"sigAlgName" : "sigAlgName",
"nonCriticalExtensionOIDs" : [ "nonCriticalExtensionOIDs", "nonCriticalExtensionOIDs" ],
"keyUsage" : [ true, true ],
"issuerAlternativeNames" : [ [ "{}", "{}" ], [ "{}", "{}" ] ],
"basicConstraints" : 6,
"issuerX500Principal" : {
"name" : "name",
"encoded" : [ "encoded", "encoded" ]
},
"subjectDN" : {
"name" : "name"
},
"criticalExtensionOIDs" : [ "criticalExtensionOIDs", "criticalExtensionOIDs" ],
"serialNumber" : 0,
"issuerUniqueID" : [ true, true ],
"issuerDN" : {
"name" : "name"
},
"tbscertificate" : [ "tbscertificate", "tbscertificate" ],
"subjectX500Principal" : {
"name" : "name",
"encoded" : [ "encoded", "encoded" ]
},
"subjectUniqueID" : [ true, true ],
"version" : 1,
"sigAlgOID" : "sigAlgOID",
"extendedKeyUsage" : [ "extendedKeyUsage", "extendedKeyUsage" ],
"encoded" : [ "encoded", "encoded" ]
}, {
"notAfter" : "2000-01-23T04:56:07.000+00:00",
"signature" : [ "signature", "signature" ],
"sigAlgParams" : [ "sigAlgParams", "sigAlgParams" ],
"subjectAlternativeNames" : [ [ "{}", "{}" ], [ "{}", "{}" ] ],
"publicKey" : {
"format" : "format",
"encoded" : [ "encoded", "encoded" ],
"algorithm" : "algorithm"
},
"type" : "type",
"notBefore" : "2000-01-23T04:56:07.000+00:00",
"sigAlgName" : "sigAlgName",
"nonCriticalExtensionOIDs" : [ "nonCriticalExtensionOIDs", "nonCriticalExtensionOIDs" ],
"keyUsage" : [ true, true ],
"issuerAlternativeNames" : [ [ "{}", "{}" ], [ "{}", "{}" ] ],
"basicConstraints" : 6,
"issuerX500Principal" : {
"name" : "name",
"encoded" : [ "encoded", "encoded" ]
},
"subjectDN" : {
"name" : "name"
},
"criticalExtensionOIDs" : [ "criticalExtensionOIDs", "criticalExtensionOIDs" ],
"serialNumber" : 0,
"issuerUniqueID" : [ true, true ],
"issuerDN" : {
"name" : "name"
},
"tbscertificate" : [ "tbscertificate", "tbscertificate" ],
"subjectX500Principal" : {
"name" : "name",
"encoded" : [ "encoded", "encoded" ]
},
"subjectUniqueID" : [ true, true ],
"version" : 1,
"sigAlgOID" : "sigAlgOID",
"extendedKeyUsage" : [ "extendedKeyUsage", "extendedKeyUsage" ],
"encoded" : [ "encoded", "encoded" ]
} ],
"notBeforeTime" : "2000-01-23T04:56:07.000+00:00",
"x509CertURL" : "https://openapi-generator.tech",
"requiredParams" : {
"key" : "{}"
},
"expirationTime" : "2000-01-23T04:56:07.000+00:00",
"keyUse" : {
"value" : "value"
},
"keyStore" : {
"provider" : {
"key" : "provider"
},
"type" : "type"
},
"keyType" : {
"requirement" : "REQUIRED",
"value" : "value"
},
"algorithm" : {
"name" : "name",
"requirement" : "REQUIRED"
}
} ],
"additionalMembers" : {
"key" : "{}"
},
"empty" : true
},
"logo_uri" : "https://openapi-generator.tech",
"valid_from" : "2000-01-23T04:56:07.000+00:00",
"client_id" : "client_id",
"token_endpoint_auth_method" : "token_endpoint_auth_method",
"require_pushed_authorization_requests" : true,
"client_secret" : "client_secret",
"pkce_mode" : "pkce_mode",
"access_token_ttl" : 5,
"policy_uri" : "https://openapi-generator.tech",
"id_token_signed_response_alg" : "RS256",
"owner" : "owner",
"persisted_consent_ttl" : 7,
"grant_types" : [ "grant_types", "grant_types" ],
"id_token_ttl" : 2,
"force_reauthentication" : true,
"redirect_uris" : [ "https://openapi-generator.tech", "https://openapi-generator.tech" ],
"confidentiality_type" : "confidentiality_type",
"id_token_encrypted_response_alg" : "RSA1_5",
"id_token_encrypted_response_enc" : "A128CBC-HS256",
"name" : "name",
"jwks_uri" : "https://openapi-generator.tech",
"comment" : "comment",
"scopes" : [ "scopes", "scopes" ],
"tos_uri" : "https://openapi-generator.tech",
"contacts" : [ "contacts", "contacts" ],
"response_types" : [ "response_types", "response_types" ],
"refresh_token_ttl" : 5
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DefaultApi;
import java.io.File;
import java.util.*;
public class DefaultApiExample {
public static void main(String[] args) {
// Create an instance of the API class
DefaultApi apiInstance = new DefaultApi();
String module = module_example; // String |
String setupId = setupId_example; // String |
OAuthV2ClientType oAuthV2ClientType = ; // OAuthV2ClientType |
try {
clientId result = apiInstance.createClient(module, setupId, oAuthV2ClientType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#createClient");
e.printStackTrace();
}
}
}
import 'package:openapi/api.dart';
final api_instance = DefaultApi();
final String module = new String(); // String |
final String setupId = new String(); // String |
final OAuthV2ClientType oAuthV2ClientType = new OAuthV2ClientType(); // OAuthV2ClientType |
try {
final result = await api_instance.createClient(module, setupId, oAuthV2ClientType);
print(result);
} catch (e) {
print('Exception when calling DefaultApi->createClient: $e\n');
}
import org.openapitools.client.api.DefaultApi;
public class DefaultApiExample {
public static void main(String[] args) {
DefaultApi apiInstance = new DefaultApi();
String module = module_example; // String |
String setupId = setupId_example; // String |
OAuthV2ClientType oAuthV2ClientType = ; // OAuthV2ClientType |
try {
clientId result = apiInstance.createClient(module, setupId, oAuthV2ClientType);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#createClient");
e.printStackTrace();
}
}
}
// Create an instance of the API class
DefaultApi *apiInstance = [[DefaultApi alloc] init];
String *module = module_example; // (default to null)
String *setupId = setupId_example; // (default to null)
OAuthV2ClientType *oAuthV2ClientType = ; // (optional)
// Create client
[apiInstance createClientWith:module
setupId:setupId
oAuthV2ClientType:oAuthV2ClientType
completionHandler: ^(clientId output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var OpenApi = require('open_api');
// Create an instance of the API class
var api = new OpenApi.DefaultApi()
var module = module_example; // {String}
var setupId = setupId_example; // {String}
var opts = {
'oAuthV2ClientType': // {OAuthV2ClientType}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.createClient(module, setupId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;
namespace Example
{
public class createClientExample
{
public void main()
{
// Create an instance of the API class
var apiInstance = new DefaultApi();
var module = module_example; // String | (default to null)
var setupId = setupId_example; // String | (default to null)
var oAuthV2ClientType = new OAuthV2ClientType(); // OAuthV2ClientType | (optional)
try {
// Create client
clientId result = apiInstance.createClient(module, setupId, oAuthV2ClientType);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling DefaultApi.createClient: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DefaultApi();
$module = module_example; // String |
$setupId = setupId_example; // String |
$oAuthV2ClientType = ; // OAuthV2ClientType |
try {
$result = $api_instance->createClient($module, $setupId, $oAuthV2ClientType);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DefaultApi->createClient: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DefaultApi;
# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DefaultApi->new();
my $module = module_example; # String |
my $setupId = setupId_example; # String |
my $oAuthV2ClientType = WWW::OPenAPIClient::Object::OAuthV2ClientType->new(); # OAuthV2ClientType |
eval {
my $result = $api_instance->createClient(module => $module, setupId => $setupId, oAuthV2ClientType => $oAuthV2ClientType);
print Dumper($result);
};
if ($@) {
warn "Exception when calling DefaultApi->createClient: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = openapi_client.DefaultApi()
module = module_example # String | (default to null)
setupId = setupId_example # String | (default to null)
oAuthV2ClientType = # OAuthV2ClientType | (optional)
try:
# Create client
api_response = api_instance.create_client(module, setupId, oAuthV2ClientType=oAuthV2ClientType)
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->createClient: %s\n" % e)
extern crate DefaultApi;
pub fn main() {
let module = module_example; // String
let setupId = setupId_example; // String
let oAuthV2ClientType = ; // OAuthV2ClientType
let mut context = DefaultApi::Context::default();
let result = client.createClient(module, setupId, oAuthV2ClientType, &context).wait();
println!("{:?}", result);
}
Scopes
Parameters
| Name | Description |
|---|---|
| module* |
String
Required
|
| setupId* |
String
Required
|
| Name | Description |
|---|---|
| oAuthV2ClientType |