{"type":"model","meta":{"id":"/apps/pubhub/media/000-v7-apis/5b3454a4300b838cc17f7b2cdc0690fdd15058d5/ba660d7b-7ccf-30c2-a2b4-4fee31bc268b","info":{"description":"Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API.\nThis API provides the following operations to manage your organization: \n\n * `/account-groups`: Account groups are used to divide an organization into different sections. These operations can be used to create, retrieve, update and delete account groups.\n * `/users`: Create, retrieve, update and delete users within an organization. \n * `/roles`: Create, retrieve and update roles for the current user. \n * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. \n * `/audit-user-events`: Retrieve all activity log events.\n\n For more information about the administrative models, see [Account Management](https://docs.thousandeyes.com/product-documentation/user-management).","title":"Administrative API","version":"7.0.34"},"security":[{"BearerAuth":[]}],"tags":[{"description":"Account group CRUD operations","name":"Account Groups"},{"description":"User CRUD operations","name":"Users"},{"description":"Role CRUD operations","name":"Roles"},{"description":"Permission GET operation","name":"Permissions"},{"description":"User events GET operation","name":"User Events"}],"externalDocs":{"description":"Find out more about the administrative models","url":"https://docs.thousandeyes.com/product-documentation/user-management"},"openapi":"3.0.1","servers":[{"description":"ThousandEyes API production URL","url":"https://api.thousandeyes.com/v7"}],"securitySchemes":{"BearerAuth":{"description":"Bearer authentication token","scheme":"bearer","type":"http"}}},"spec":{"properties":{"name":{"description":"User's display name.","example":"User X","type":"string"},"email":{"description":"User's email address.","example":"userx@thousandeyes.com","format":"email","type":"string"},"uid":{"description":"Unique ID of the user.","example":"245","type":"string"},"dateRegistered":{"description":"UTC date the user registered their account (ISO date-time format).","example":"2020-07-17T22:00:54Z","format":"date-time","type":"string"},"loginAccountGroup":{"properties":{"aid":{"description":"A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint.","example":"1234","type":"string"},"accountGroupName":{"description":"Account group name","example":"Account A","type":"string"}},"type":"object","$$ref":"#/components/schemas/AccountGroup"},"accountGroupRoles":{"items":{"properties":{"accountGroup":{"properties":{"aid":{"description":"A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint.","example":"1234","type":"string"},"accountGroupName":{"description":"Account group name","example":"Account A","type":"string"}},"type":"object","$$ref":"#/components/schemas/AccountGroup"},"roles":{"items":{"properties":{"name":{"description":"Name of the role.","example":"Organization Admin","type":"string"},"roleId":{"description":"Unique ID representing the role.","example":"35","type":"string"},"isBuiltin":{"description":"Flag indicating if the role is built-in (Account Admin, Organization Admin, Regular User).","type":"boolean"},"hasManagementPermissions":{"description":"Flag indicating whether the user has management permissions.","type":"boolean"}},"type":"object","$$ref":"#/components/schemas/Role"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/AccountGroupRole"},"type":"array"},"allAccountGroupRoles":{"items":{"properties":{"name":{"description":"Name of the role.","example":"Organization Admin","type":"string"},"roleId":{"description":"Unique ID representing the role.","example":"35","type":"string"},"isBuiltin":{"description":"Flag indicating if the role is built-in (Account Admin, Organization Admin, Regular User).","type":"boolean"},"hasManagementPermissions":{"description":"Flag indicating whether the user has management permissions.","type":"boolean"}},"type":"object","$$ref":"#/components/schemas/Role"},"type":"array"},"_links":{"description":"A links object containing the self link.","properties":{"self":{"description":"A hyperlink from the containing resource to a URI.","properties":{"href":{"description":"Its value is either a URI [RFC3986] or a URI template [RFC6570].","example":"https://api.thousandeyes.com/v7/link/to/resource/id","type":"string"},"templated":{"description":"Should be true when the link object's \"href\" property is a URI template.","type":"boolean"},"type":{"description":"Used as a hint to indicate the media type expected when dereferencing the target resource.","type":"string"},"deprecation":{"description":"Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation.","type":"string"},"name":{"description":"Its value may be used as a secondary key for selecting link objects that share the same relation type.","type":"string"},"profile":{"description":"A URI that hints about the profile of the target resource.","type":"string"},"title":{"description":"Intended for labelling the link with a human-readable identifier","type":"string"},"hreflang":{"description":"Indicates the language of the target resource","type":"string"}},"required":["href"],"type":"object","$$ref":"#/components/schemas/Link"}},"readOnly":true,"type":"object","$$ref":"#/components/schemas/SelfLinks"}},"type":"object","$$ref":"#/components/schemas/CreatedUser","title":"CreatedUser"}}