Create

Create an access profile under a resource server. The backend also provisions a backing AppEntitlement that users request to be granted the profile’s scopes.

POST /api/v1/apps/{app_id}/xaa/access_profiles

Create

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.XAAAccessProfile.Create(ctx, operations.C1APICrossAppAccessV1XAAAccessProfileServiceCreateRequest{
        AppID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.XAAAccessProfileServiceCreateResponse != nil {
        // handle response
    }
}

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/xaa/access_profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "displayName": "<string>",
  "xaaResourceServerId": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/xaa/access_profiles"

payload = {
    "description": "<string>",
    "displayName": "<string>",
    "xaaResourceServerId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    displayName: '<string>',
    xaaResourceServerId: '<string>'
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/xaa/access_profiles', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/xaa/access_profiles",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'displayName' => '<string>',
    'xaaResourceServerId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/xaa/access_profiles")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"xaaResourceServerId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/apps/{app_id}/xaa/access_profiles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"xaaResourceServerId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "accessProfile": {
    "appEntitlementId": "<string>",
    "appId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "displayName": "<string>",
    "id": "<string>",
    "scopeCount": 123,
    "updatedAt": "2023-11-07T05:31:56Z",
    "xaaResourceServerId": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

app_id · string · required

The application that owns the resource server.

Body

application/json

XAAAccessProfileServiceCreateRequest creates a new access profile.

description · string

Description of what access this profile grants.

displayName · string

Display name for the profile.

xaaResourceServerId · string

The resource server this profile grants access to.

Response

200 - application/json

XAAAccessProfileServiceCreateResponse returns the created access profile.

XAAAccessProfileServiceCreateResponse returns the created access profile.

accessProfile · Xaa Access Profile · object | null

XAAAccessProfile is a requestable bundle of scopes for one resource server.

Show child attributes