- Primeros pasos
- Autenticación
- Ámbitos y permisos
- API de gestión de plataformas
Asignar licencias a un grupo
Como administrador de la organización, utiliza este punto final para asignar licencias a un grupo. Para ello, debes crear una aplicación externa, con el ámbito PM.License.Write.
Descubre cómo crear una aplicación externa.
Punto final de API
PUT https://{yourDomain}/{organizationName}/lease_/api/account/{accountId}/user-license/group/{groupId}
Solicitar encabezados.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
To obtain the {access_token}, make sure to authenticate through the ROPC method described here.
Parámetros de ruta
| Parámetros de ruta | Tipo de datos | Descripción |
|---|---|---|
accountId(obligatorio) | Cadena | El ID de la organización en la que reside su tenant. |
groupId(obligatorio) | Cadena | El ID del grupo al que desea asignar licencias. You can retrieve this ID by following these steps. |
Solicitar cuerpo
El cuerpo de la solicitud contiene la matriz de códigos de licencia para varios productos y su cantidad correspondiente.
{
"userBundleCodes": ["string"]
}
{
"userBundleCodes": ["string"]
}
- To see the available user bundle codes you may use in the request body, check out the user license codes.
- Puede asignar tantas licencias como haya adquirido la organización.
Respuesta
200 OK
Devuelve las licencias de grupo asignadas.
404
No se asigna ninguna licencia de cuenta para la organización indicada.
Solicitud de ejemplo
Supongamos que has recopilado toda la información necesaria para crear la llamada a la API.
- Su
{baseURL}es:https://{yourDomain}/{organizationName}. - Tu
{access_token}es:1234(para consideraciones de longitud) - El
{accountId}del tenant que necesita asignación de licencia es:song-one - El
{groupId}es:group-01. - Desea asignar licencias de usuario al grupo de la siguiente manera:
- Automation Developers - Named user (the license code is
RPADEVPRONU) - Insights Designer (the license code is
IDU) - Citizen Developer - Multiuser (the license code is
CTZDEVCU)
- Automation Developers - Named user (the license code is
La llamada debe parecerse al siguiente ejemplo (cURL):
curl --location --request POST 'https://https://{yourDomain}/{organizationName}/lease_/api/account/1234/user-license/group/group-01' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"userBundleCodes": ["RPADEVPRONU", "IDU", "CTZDEVCU"],
"useExternalLicense": false
}'
curl --location --request POST 'https://https://{yourDomain}/{organizationName}/lease_/api/account/1234/user-license/group/group-01' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
"userBundleCodes": ["RPADEVPRONU", "IDU", "CTZDEVCU"],
"useExternalLicense": false
}'
Este es el cuerpo de respuesta para una asignación de licencia exitosa:
{
"groupId": "string",
"organizationId": "string",
"useExternalLicense": false,
"userBundleCodes": [
"string"
]
}
{
"groupId": "string",
"organizationId": "string",
"useExternalLicense": false,
"userBundleCodes": [
"string"
]
}