Pular para o conteúdo principal
API docs by Redocly

StackSpot IAM - Scim Provider API (1.0)

Download OpenAPI specification:Download

API Support: idmngr@zup.com.br

actions

GetAll Actions

GetAll Actions

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "totalResults": 0
}

Create Action

Create a new action

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Create Action

client_id
string
description
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Get Action

Get action by id

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Update Actions

Update Actions

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Update Action

client_id
string
description
string
name
required
string

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "description": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "totalResults": 0
}

Delete Action

Delete Action

header Parameters
Authorization
required
string

Bearer token

Responses

Patch Operation Action

Patch Operation Action

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Update Action

Array of objects
schemas
string

Responses

Request samples

Content type
application/json
{
  • "Operations": [
    ],
  • "schemas": "string"
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

groups

GetAll Groups

GetAll Groups

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "totalResults": 0
}

Create Group

Create a new group

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Create Group

displayName
required
string

Responses

Request samples

Content type
application/json
{
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Get Group

Get group by id

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Update Groups

Update Groups

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Update Group

displayName
string

Responses

Request samples

Content type
application/json
{
  • "displayName": "string"
}

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "totalResults": 0
}

Delete Group

Delete Group

header Parameters
Authorization
required
string

Bearer token

Responses

Patch Operation Group

Patch Operation Group

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Update Group

Array of objects
schemas
string

Responses

Request samples

Content type
application/json
{
  • "Operations": [
    ],
  • "schemas": "string"
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

permissions

GetAll Permissions

GetAll Permissions

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "totalResults": 0
}

Create Permission

Create a new permission

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Create Permission

client_id
string
description
string
name
required
string
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "description": "string",
  • "name": "string",
  • "statements": [
    ]
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Update Permissions

Update Permissions

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Update Permission

client_id
string
description
string
name
required
string
Array of objects

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "description": "string",
  • "name": "string",
  • "statements": [
    ]
}

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "totalResults": 0
}

Delete Permission

Delete Permission

header Parameters
Authorization
required
string

Bearer token

Responses

Patch Operation Permission

Patch Operation Permission

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Update Permission

Array of objects
schemas
string

Responses

Request samples

Content type
application/json
{
  • "Operations": [
    ],
  • "schemas": "string"
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Get Permission

Get permission by id

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

resource-type

GetAll Resource-Type

Getall resource-types

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "totalResults": 0
}

Create Resource-Type

Create a new resource-type

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Create Resource

actions
required
Array of strings
client_id
string
description
string
name
required
string
slug
string

Responses

Request samples

Content type
application/json
{
  • "actions": [
    ],
  • "client_id": "string",
  • "description": "string",
  • "name": "string",
  • "slug": "string"
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Get Resource-Type

Get resource-type by id

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Replace Resource-Type

Replace resource-types

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Create Resource

client_id
string
description
string
name
required
string
slug
required
string

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "description": "string",
  • "name": "string",
  • "slug": "string"
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Patch Operation Resource-Type

Patch Operation resource-types

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Update Resource

Array of objects
schemas
string

Responses

Request samples

Content type
application/json
{
  • "operations": [
    ],
  • "schemas": "string"
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Remove Resource-Type

Remove resource-types

header Parameters
Authorization
required
string

Bearer token

Responses

resources

Get Resource

Get resource

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "totalResults": 0
}

Create Resource

Create a new resource

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Create Resource

client_id
string
description
string
name
required
string
slug
string
type
required
string

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "description": "string",
  • "name": "string",
  • "slug": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Get Resource

Get resource by id

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Replace Resource

Replace resource

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Update Resource

client_id
string
description
string
name
required
string
slug
required
string
type
required
string

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "description": "string",
  • "name": "string",
  • "slug": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Remove Resource

Remove resource by id

header Parameters
Authorization
required
string

Bearer token

Responses

Patch Operation Resource

Patch Operation a new resource

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Update Resource

Array of objects
schemas
string

Responses

Request samples

Content type
application/json
{
  • "Operations": [
    ],
  • "schemas": "string"
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

roles

GetAll Roles

GetAll Roles

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "totalResults": 0
}

Create Role

Create a new role

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Create Role

object
client_id
string
description
string
id
string
name
required
string
permissions
Array of strings
Array of objects

Responses

Request samples

Content type
application/json
{
  • "claim_mapper": {
    },
  • "client_id": "string",
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "permissions": [
    ],
  • "statements": [
    ]
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Update Roles

Update Roles

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Update Role

object
client_id
string
description
string
name
required
string
permissions
Array of strings

Responses

Request samples

Content type
application/json
{
  • "claim_mapper": {
    },
  • "client_id": "string",
  • "description": "string",
  • "name": "string",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "totalResults": 0
}

Delete Role

Delete Role

header Parameters
Authorization
required
string

Bearer token

Responses

Patch Operation Role

Patch Operation Role

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Update Role

Array of objects
schemas
string

Responses

Request samples

Content type
application/json
{
  • "Operations": [
    ],
  • "schemas": "string"
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Get Role

Get role by id

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

users

GetAll User

GetAll User

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "totalResults": 0
}

Create User

Create a new user

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Create User

active
boolean
displayName
string
Array of objects
locale
string
object
nickName
string
password
string
Array of objects
preferredLanguage
string
profileUrl
string
timezone
string
title
string
object
userName
string
userType
string

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "displayName": "string",
  • "emails": [
    ],
  • "locale": "string",
  • "name": {
    },
  • "nickName": "string",
  • "password": "string",
  • "phoneNumbers": [
    ],
  • "preferredLanguage": "string",
  • "profileUrl": "string",
  • "timezone": "string",
  • "title": "string",
  • "urn:ietf:params:scim:schemas:extension:custom:2.0:User": {
    },
  • "userName": "string",
  • "userType": "string"
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Update Users

Update Users

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Update User

Array of objects
object
Array of objects
object
userName
string

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ],
  • "name": {
    },
  • "phoneNumbers": [
    ],
  • "urn:ietf:params:scim:schemas:extension:custom:2.0:User": {
    },
  • "userName": "string"
}

Response samples

Content type
application/json
{
  • "resources": [
    ],
  • "totalResults": 0
}

Delete User

Delete User

header Parameters
Authorization
required
string

Bearer token

Responses

Patch Operation User

Patch Operation User

header Parameters
Authorization
required
string

Bearer token

Request Body schema: application/json
required

Update User

Array of objects
schemas
string

Responses

Request samples

Content type
application/json
{
  • "Operations": [
    ],
  • "schemas": "string"
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}

Get User

Get user by id

header Parameters
Authorization
required
string

Bearer token

Responses

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "externalID": { },
  • "id": "string",
  • "meta": {
    },
  • "schemas": [
    ]
}