Skip to main content

Get Role

GET 
/api/v1/infra/collections/:collectionId/roles/:roleId

Retrieves a specific IAM role assigned to a user within a collection. Returns detailed role information including permissions, trust policies, attached policies, and metadata such as creation date and usage statistics.

Parameter Details​

Header Parameters​

  • integrationid (required): Unique identifier for the cloud provider integration configured in your Unizo account. This UUID associates the API request with the specific cloud account credentials and permissions.

Path Parameters​

  • collectionId (required): Unique identifier for the collection within the specified cloud provider. Format varies by provider:

    • AWS: Region identifier for compliance environments (e.g., us-east-1 for US compliance, eu-west-1 for GDPR compliance)
    • Google Cloud: Project ID for governance environments (e.g., prod-compliance-env, audit-data-project-2024)
    • Azure: Use "default" when no specific subscription or resource group mapping is configured
    • Other providers: Provider-specific collection identifiers

  • userId (required): Unique identifier for the user account within the cloud provider's identity system. Format examples:

    • AWS: IAM user name for GRC roles (e.g., compliance-auditor, security-analyst, governance-admin) or ARN
    • Google Cloud: Email address for audit team members (e.g., auditor@company.com, compliance@company.com) or user ID
    • Azure: User principal name for GRC team (e.g., grc-team@company.com, audit.admin@company.com) or object ID
    • Other providers: Provider-specific user identifiers

  • roleId (required): Unique identifier for the IAM role within the cloud provider. Format examples:

    • AWS: Role name for compliance roles (e.g., ComplianceAuditorRole, SecurityReadOnlyRole, GRCAuditRole) or role ARN
    • Google Cloud: Role ID for security auditing (e.g., roles/securitycenter.auditor, roles/cloudkms.viewer) or custom role name
    • Azure: Role definition ID for governance (e.g., Security Reader, Compliance Manager, Audit Reader) or built-in role name

Request​

Responses​

Successful Operation