DocumentatieExperience PlatformHandleiding voor toegangsbeheer

Het eindpunt van rollen

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Gemaakt voor:

  • Ontwikkelaar
NOTE
Als een gebruikerstoken wordt overgegaan, dan moet de gebruiker van het teken een "org admin"rol voor gevraagde org hebben.

De rollen bepalen de toegang die een beheerder, een specialist, of een eindgebruiker aan middelen in uw organisatie moet hebben. In een op rol-gebaseerd milieu van het toegangsbeheer, is de levering van de gebruikerstoegang groepering door gemeenschappelijke verantwoordelijkheden en behoeften. Een rol heeft een bepaalde reeks toestemmingen en de leden van uw organisatie kunnen aan één of meerdere rollen, afhankelijk van het werkingsgebied van mening worden toegewezen of toegang schrijven zij nodig hebben.

Het /roles eindpunt in op attribuut-gebaseerde toegangsbeheer API staat u toe om rollen in uw organisatie programmatically te beheren.

Aan de slag

Het API eindpunt dat in deze gids wordt gebruikt maakt deel uit van op attribuut-gebaseerde toegangsbeheer API. Alvorens verder te gaan, te herzien gelieve begonnen gidsvoor verbindingen aan verwante documentatie, een gids aan het lezen van de steekproefAPI vraag in dit document, en belangrijke informatie betreffende vereiste kopballen die nodig zijn om vraag aan om het even welk Experience Platform API met succes te maken.

Een lijst met rollen ophalen list

U kunt alle bestaande rollen die tot uw organisatie behoren, weergeven door een aanvraag voor een GET in te dienen bij het /roles eindpunt.

API formaat

GET /roles/

Verzoek

Het volgende verzoek wint een lijst van rollen terug die tot uw organisatie behoren.

curl -X GET \
  https://platform.adobe.io/data/foundation/access-control/administration/roles \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \

Reactie

Een succesvolle reactie keert een lijst van rollen in uw organisatie, met inbegrip van informatie over hun respectieve roltype, toestemmingsreeksen, en onderwerpattributen terug.

{
  "roles": [
    {
      "id": "3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809",
      "name": "Administrator Role",
      "description": "Role for administrator type of responsibilities and access",
      "roleType": "user-defined",
      "permissionSets": [
        "manage-datasets",
        "manage-schemas"
      ],
      "sandboxes": [
        "prod"
      ],
      "subjectAttributes": {
        "labels": [
          "core/S1"
        ]
      },
      "createdBy": "{CREATED_BY}",
      "createdAt": 1648153201825,
      "modifiedBy": "{MODIFIED_BY}",
      "modifiedAt": 1648153201825,
      "etag": null
    }
  ],
  "_page": {
    "limit": 1,
    "count": 1
  },
  "_links": {
    "next": {
      "href": "https://platform.adobe.io:443/data/foundation/access-control/administration/roles/3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809",
      "templated": true
    },
    "page": {
      "href": "https://platform.adobe.io:443/data/foundation/access-control/administration/roles/3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809",
      "templated": true
    },
    "subjects": {
      "href": "https://platform.adobe.io:443/data/foundation/access-control/administration/roles/3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809",
      "templated": true
    }
  }
}
Eigenschap
Beschrijving
id
De id die overeenkomt met de rol. Deze id wordt automatisch gegenereerd.
name
De naam van uw rol.
description
Het beschrijvingsbezit verstrekt extra informatie over uw rol.
roleType
Het aangewezen type van de rol. De mogelijke waarden voor het roltype zijn: user-defined en system-defined .
permissionSets
Machtigingssets vertegenwoordigen een groep machtigingen die een beheerder op een rol kan toepassen. Een beheerder kan rechtensets toewijzen aan een rol in plaats van individuele machtigingen toe te wijzen. Dit staat u toe om douanerollen van een vooraf bepaalde rol tot stand te brengen die een groep toestemmingen bevat.
sandboxes
Met deze eigenschap worden de sandboxen binnen uw organisatie weergegeven die zijn ingericht voor een bepaalde rol.
subjectAttributes
De attributen die op de correlatie tussen een onderwerp en de middelen van het Platform wijzen die zij hebben toegang tot.
subjectAttributes.labels
Hiermee geeft u de labels voor gegevensgebruik weer die op de gevraagde rol zijn toegepast.

Rol opzoeken lookup

U kunt een individuele rol omhoog zoeken door een verzoek van de GET te doen die het overeenkomstige roleId in de verzoekweg omvat.

API formaat

GET /roles/{ROLE_ID}
Parameter
Beschrijving
De id van de rol die u wilt opzoeken.

Verzoek

Met de volgende aanvraag wordt informatie voor {ROLE_ID} opgehaald.

curl -X GET \
  https://platform.adobe.io/data/foundation/access-control/administration/roles/3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \

Reactie

Een succesvolle reactie keert details voor gevraagde rol identiteitskaart, met inbegrip van informatie over zijn roltype, toestemmingsreeksen, en onderwerpattributen terug.

{
  "id": "3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809",
  "name": "Administrator Role",
  "description": "Role for administrator type of responsibilities and access",
  "roleType": "user-defined",
  "permissionSets": [
    "manage-datasets",
    "manage-schemas"
  ],
  "sandboxes": [
    "prod"
  ],
  "subjectAttributes": {
    "labels": [
      "core/S1"
    ]
  },
  "createdBy": "{CREATED_BY}",
  "createdAt": 1648153201825,
  "modifiedBy": "{MODIFIED_BY}",
  "modifiedAt": 1648153201825,
  "etag": null
}
Eigenschap
Beschrijving
id
De id die overeenkomt met de rol. Deze id wordt automatisch gegenereerd.
name
De naam van uw rol.
description
Het beschrijvingsbezit verstrekt extra informatie over uw rol.
roleType
Het aangewezen type van de rol. De mogelijke waarden voor het roltype zijn: user-defined en system-defined .
permissionSets
Machtigingssets vertegenwoordigen een groep machtigingen die een beheerder op een rol kan toepassen. Een beheerder kan rechtensets toewijzen aan een rol in plaats van individuele machtigingen toe te wijzen. Dit staat u toe om douanerollen van een vooraf bepaalde rol tot stand te brengen die een groep toestemmingen bevat.
sandboxes
Met deze eigenschap worden de sandboxen binnen uw organisatie weergegeven die zijn ingericht voor een bepaalde rol.
subjectAttributes
De attributen die op de correlatie tussen een onderwerp en de middelen van het Platform wijzen die zij hebben toegang tot.
subjectAttributes.labels
Hiermee geeft u de labels voor gegevensgebruik weer die op de gevraagde rol zijn toegepast.

Onderwerpen opzoeken op rol-id

U kunt onderwerpen ook ophalen door een GET-aanvraag in te dienen bij het eindpunt van /roles terwijl u een {ROLE_ID} opgeeft.

API formaat

GET /roles/{ROLE_ID}/subjects
Parameter
Beschrijving
De id van de rol die is gekoppeld aan de onderwerpen die u wilt opzoeken.

Verzoek

Met de volgende aanvraag worden onderwerpen opgehaald die aan 3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809 zijn gekoppeld.

curl -X GET \
  https://platform.adobe.io/data/foundation/access-control/administration/roles/3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809/subjects \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \

Reactie

Een succesvolle reactie retourneert de onderwerpen die aan de betrokken rol-id zijn gekoppeld, inclusief de overeenkomstige onderwerp-id en het bijbehorende onderwerptype.

{
  "items": [
      {
          "roleId": "3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809",
          "subjectType": "user",
          "subjectId": "03Z07HFQCCUF3TUHAX274206@AdobeID"
      },
      {
          "roleId": "3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809",
          "subjectType": "user",
          "subjectId": "PIRJ7WE5T3QT9Z4TCLVH86DE@AdobeID"
      },
      {
          "roleId": "3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809",
          "subjectType": "user",
          "subjectId": "WHPWE00MC26SHZ7AKBFG403D@AdobeID"
      },
  ]
  "_page": {
    "limit": 0,
    "count": 0
  },
  "_links": {
      "self": {
          "href": "/roles/{ROLE_ID}/subjects",
          "templated": false,
          "type": null,
          "method": null
      },
      "page": {
          "href": "/roles/{ROLE_ID}/subjects?limit={limit}&start={start}&orderBy={orderBy}&property={property}",
          "templated": true,
          "type": null,
          "method": null
      }
  }
}
Eigenschap
Beschrijving
roleId
De rol-id die is gekoppeld aan het onderwerp waarnaar wordt gevraagd.
subjectType
Het type van het onderwerp waarnaar wordt gevraagd.
subjectId
De id die overeenkomt met het onderwerp in kwestie.

Een rol maken create

Om een nieuwe rol tot stand te brengen, doe een verzoek van de POST aan het /roles eindpunt terwijl het verstrekken van waarden voor de naam van uw rol, beschrijving, en roltype.

API formaat

POST /roles/

Verzoek

curl -X POST \
  https://platform.adobe.io/data/foundation/access-control/administration/roles \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}'
  -d'{
    "name": "Administrator Role",
    "description": "Role for administrator type of responsibilities and access",
    "roleType": "user-defined"
  }'
Eigenschap
Beschrijving
name
De naam van uw rol. Zorg ervoor dat de naam van uw rol beschrijvend is aangezien u dit kunt gebruiken om informatie over uw rol op te zoeken.
description
(Optioneel) Een beschrijvende waarde die u kunt opnemen voor meer informatie over uw rol.
roleType
Het aangewezen type van de rol. De mogelijke waarden voor het roltype zijn: user-defined en system-defined .

Reactie

Een succesvolle reactie keert uw onlangs gecreëerde rol, met zijn overeenkomstige rol identiteitskaart, evenals informatie over zijn roltype, toestemmingsreeksen, en onderwerpattributen terug.

{
  "id": "3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809",
  "name": "Administrator Role",
  "description": "Role for administrator type of responsibilities and access",
  "roleType": "user-defined",
  "permissionSets": [
    "manage-datasets",
    "manage-schemas"
  ],
  "sandboxes": [
    "prod"
  ],
  "subjectAttributes": {
    "labels": [
      "core/S1"
    ]
  },
  "createdBy": "{CREATED_BY}",
  "createdAt": 1648153201825,
  "modifiedBy": "{MODIFIED_BY}",
  "modifiedAt": 1648153201825,
  "etag": null
}
Eigenschap
Beschrijving
id
De id die overeenkomt met de rol. Deze id wordt automatisch gegenereerd.
name
De naam van uw rol.
description
Het beschrijvingsbezit verstrekt extra informatie over uw rol.
roleType
Het aangewezen type van de rol. De mogelijke waarden voor het roltype zijn: user-defined en system-defined .
permissionSets
Machtigingssets vertegenwoordigen een groep machtigingen die een beheerder op een rol kan toepassen. Een beheerder kan rechtensets toewijzen aan een rol in plaats van individuele machtigingen toe te wijzen. Dit staat u toe om douanerollen van een vooraf bepaalde rol tot stand te brengen die een groep toestemmingen bevat.
sandboxes
Met deze eigenschap worden de sandboxen binnen uw organisatie weergegeven die zijn ingericht voor een bepaalde rol.
subjectAttributes
De attributen die op de correlatie tussen een onderwerp en de middelen van het Platform wijzen die zij hebben toegang tot.
subjectAttributes.labels
Hiermee geeft u de labels voor gegevensgebruik weer die op de gevraagde rol zijn toegepast.

Een rol bijwerken patch

U kunt de eigenschappen van een rol bijwerken door een verzoek van PATCH aan het /roles eindpunt te doen terwijl het verstrekken van overeenkomstige rol identiteitskaart en waarden voor de verrichtingen u wilt toepassen.

API formaat

PATCH /roles/{ROLE_ID}
Parameter
Beschrijving
De id van de rol die u wilt bijwerken.

Verzoek

curl -X PATCH \
  https://platform.adobe.io/data/foundation/access-control/administration/roles/{ROLE_ID} \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}'
  -d'{
    "operations": [
      {
        "op": "add",
        "path": "/description",
        "value": "Role with permission sets for admin type of access"
      }
    ]
  }'
Bewerkingen
Beschrijving
op
De verrichtingsvraag die wordt gebruikt om de actie te bepalen nodig om de rol bij te werken. Bewerkingen zijn: add , replace en remove .
path
Het pad van de parameter die moet worden bijgewerkt.
value
De nieuwe waarde waarmee u de parameter wilt bijwerken.

Reactie

Een geslaagde reactie retourneert de bijgewerkte rol, inclusief nieuwe waarden voor de eigenschappen die u wilt bijwerken.

{
  "id": "3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809",
  "name": "Administrator Role",
  "description": "Role with permission sets for admin type of access",
  "roleType": "user-defined",
  "permissionSets": [
    "manage-datasets",
    "manage-schemas"
  ],
  "sandboxes": [
    "prod"
  ],
  "subjectAttributes": {
    "labels": [
      "core/S1"
    ]
  },
  "createdBy": "{CREATED_BY}",
  "createdAt": 1648153201825,
  "modifiedBy": "{MODIFIED_BY}",
  "modifiedAt": 1648153201825,
  "etag": null
}
Eigenschap
Beschrijving
id
De id die overeenkomt met de rol. Deze id wordt automatisch gegenereerd.
name
De naam van uw rol.
description
Het beschrijvingsbezit verstrekt extra informatie over uw rol.
roleType
Het aangewezen type van de rol. De mogelijke waarden voor het roltype zijn: user-defined en system-defined .
permissionSets
Machtigingssets vertegenwoordigen een groep machtigingen die een beheerder op een rol kan toepassen. Een beheerder kan rechtensets toewijzen aan een rol in plaats van individuele machtigingen toe te wijzen. Dit staat u toe om douanerollen van een vooraf bepaalde rol tot stand te brengen die een groep toestemmingen bevat.
sandboxes
Met deze eigenschap worden de sandboxen binnen uw organisatie weergegeven die zijn ingericht voor een bepaalde rol.
subjectAttributes
De attributen die op de correlatie tussen een onderwerp en de middelen van het Platform wijzen die zij hebben toegang tot.
subjectAttributes.labels
Hiermee geeft u de labels voor gegevensgebruik weer die op de gevraagde rol zijn toegepast.

Rollen bijwerken op rol-id put

U kunt een rol bijwerken door een verzoek van de PUT aan het /roles eindpunt te richten en rolidentiteitskaart te specificeren die aan de rol beantwoordt u wilt bijwerken.

API formaat

PUT /roles/{ROLE_ID}

Verzoek

Met de volgende aanvraag worden de naam, beschrijving en het roltype voor rol-id bijgewerkt: 3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809 .

curl -X PUT \
  https://platform.adobe.io/data/foundation/access-control/administration/roles/3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}'
  -d'{
    "name": "Administrator role for ACME",
    "description": "New administrator role for ACME",
    "roleType": "user-defined"
  }'
Parameter
Beschrijving
name
De bijgewerkte naam van een rol.
description
De bijgewerkte beschrijving van een rol.
roleType
Het aangewezen type van de rol. De mogelijke waarden voor het roltype zijn: user-defined en system-defined .

Reactie

Een succesvolle reactie keert uw bijgewerkte rol, met inbegrip van nieuwe waarden voor zijn naam, beschrijving, en roltype terug.

{
  "id": "3dfa045d-de58-4dfd-8ea9-e4e2c1b6d809",
  "name": "Administrator role for ACME",
  "description": "New administrator role for ACME",
  "roleType": "user-defined",
  "permissionSets": [
    "manage-datasets",
    "manage-schemas"
  ],
  "sandboxes": [
    "prod"
  ],
  "subjectAttributes": {
    "labels": [
      "core/S1"
    ]
  },
  "createdBy": "{CREATED_BY}",
  "createdAt": 1648153201825,
  "modifiedBy": "{MODIFIED_BY}",
  "modifiedAt": 1648153201825,
  "etag": null
}
Eigenschap
Beschrijving
id
De id die overeenkomt met de rol. Deze id wordt automatisch gegenereerd.
name
De naam van uw rol.
description
Het beschrijvingsbezit verstrekt extra informatie over uw rol.
roleType
Het aangewezen type van de rol. De mogelijke waarden voor het roltype zijn: user-defined en system-defined .
permissionSets
Machtigingssets vertegenwoordigen een groep machtigingen die een beheerder op een rol kan toepassen. Een beheerder kan rechtensets toewijzen aan een rol in plaats van individuele machtigingen toe te wijzen. Dit staat u toe om douanerollen van een vooraf bepaalde rol tot stand te brengen die een groep toestemmingen bevat.
sandboxes
Met deze eigenschap worden de sandboxen binnen uw organisatie weergegeven die zijn ingericht voor een bepaalde rol.
subjectAttributes
De attributen die op de correlatie tussen een onderwerp en de middelen van het Platform wijzen die zij hebben toegang tot.
subjectAttributes.labels
Hiermee geeft u de labels voor gegevensgebruik weer die op de gevraagde rol zijn toegepast.

Onderwerp bijwerken op rol-id

Om de onderwerpen bij te werken verbonden aan een rol, doe een verzoek van PATCH aan het /roles eindpunt terwijl het verstrekken van rolidentiteitskaart van de onderwerpen u wilt bijwerken.

API formaat

PATCH /roles/{ROLE_ID}/subjects
Parameter
Beschrijving
De id van de rol die is gekoppeld aan de onderwerpen die u wilt bijwerken.

Verzoek

De volgende aanvraag werkt de onderwerpen bij die aan {ROLE_ID} zijn gekoppeld.

curl --location --request PATCH 'https://platform.adobe.io/data/foundation/access-control/administration/roles/<ROLE_ID>/subjects' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "op": "add",
        "path": "/user",
        "value": "{USER ID}"
    }
]'
Bewerkingen
Beschrijving
op
De verrichtingsvraag die wordt gebruikt om de actie te bepalen nodig om de rol bij te werken. Bewerkingen zijn: add , replace en remove .
path
Het pad van de parameter die moet worden bijgewerkt.
value
De nieuwe waarde waarmee u de parameter wilt bijwerken.

Reactie

Een succesvolle reactie retourneert uw bijgewerkte rol, inclusief nieuwe waarden voor de onderwerpen.

{
  "subjects": [
    [
      {
        "subjectId": "03Z07HFQCCUF3TUHAX274206@AdobeID",
        "subjectType": "user"
      }
    ]
  ],
  "_page": {
    "limit": 1,
    "count": 1
  },
  "_links": {
    "self": {
      "href": "https://platform.adobe.io:443/data/foundation/access-control/administration/roles/{ROLE_ID}/subjects",
      "templated": true
    },
    "page": {
      "href": "https://platform.adobe.io:443/data/foundation/access-control/administration/roles/{ROLE_ID}/subjects?limit={limit}&start={start}&orderBy={orderBy}&property={property}",
      "templated": true
    }
  }
}

Een rol verwijderen delete

Als u een rol wilt verwijderen, vraagt u een DELETE aan het /roles -eindpunt terwijl u de id opgeeft van de rol die u wilt verwijderen.

API formaat

DELETE /roles/{ROLE_ID}
Parameter
Beschrijving
De id van de rol die u wilt verwijderen.

Verzoek

Met het volgende verzoek wordt de rol met de id {ROLE_ID} verwijderd.

curl -X DELETE \
  https://platform.adobe.io/data/foundation/access-control/administration/roles/{ROLE_ID} \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \

Reactie

Een geslaagde reactie retourneert HTTP-status 204 (Geen inhoud) en een lege hoofdtekst.

U kunt de schrapping bevestigen door een raadpleging (GET) verzoek aan de rol te proberen. U ontvangt de HTTP-status 404 (Niet gevonden) omdat de rol uit het beheer is verwijderd.

API-referentie toevoegen apicredential

Als u API-referentie wilt toevoegen, vraagt u een PATCH-aanvraag naar het eindpunt van /roles en geeft u de rol-id van de onderwerpen op.

API formaat

curl --location --request PATCH 'https://platform.adobe.io/data/foundation/access-control/administration/roles/<ROLE_ID>/subjects' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-api-key: {API_KEY}' \
--header 'x-gw-ims-org-id: {IMS_ORG}' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "op": "add",
        "path": "/api-integration",
        "value": "{TECHNICAL ACCOUNT ID}"
    }
]'
Bewerkingen
Beschrijving
op
De verrichtingsvraag die wordt gebruikt om de actie te bepalen nodig om de rol bij te werken. Bewerkingen zijn: add , replace en remove .
path
Het pad van de parameter die moet worden toegevoegd.
value
De waarde waarmee u de parameter wilt toevoegen.

Reactie

Een geslaagde reactie retourneert HTTP-status 204 (Geen inhoud) en een lege hoofdtekst.

recommendation-more-help
631fcab2-5cb1-46ef-ba66-fe098ac723e0